Crossencoder Mminilmv2 L12 Mmarcofr

🚀 crossencoder-mMiniLMv2-L12-mmarcoFR

This is a cross-encoder model designed for the French language. It conducts cross-attention between a question-passage pair and outputs a relevance score. The model serves as a reranker for semantic search. Given a query and a set of potentially relevant passages retrieved by an efficient first-stage retrieval system (e.g., BM25 or a fine-tuned dense single-vector bi-encoder), it encodes each query-passage pair and sorts the passages in descending order of relevance according to the model's predicted scores.

🚀 Quick Start

Here are some examples for using the model with Sentence-Transformers, FlagEmbedding, or Huggingface Transformers.

✨ Features

• Text Ranking: Specifically designed for text ranking tasks, especially passage reranking.
• Cross-Attention: Performs cross-attention between question-passage pairs to output relevance scores.
• Semantic Search Reranking: Ideal for reranking passages in semantic search scenarios.

📦 Installation

To use this model, you need to install the corresponding libraries:

• Sentence-Transformers: pip install -U sentence-transformers
• FlagEmbedding: pip install -U FlagEmbedding
• Huggingface Transformers: pip install -U transformers

💻 Usage Examples

Basic Usage

Using Sentence-Transformers

from sentence_transformers import CrossEncoder

pairs = [('Question', 'Paragraphe 1'), ('Question', 'Paragraphe 2') , ('Question', 'Paragraphe 3')]

model = CrossEncoder('antoinelouis/crossencoder-mMiniLMv2-L12-mmarcoFR')
scores = model.predict(pairs)
print(scores)

Using FlagEmbedding

from FlagEmbedding import FlagReranker

pairs = [('Question', 'Paragraphe 1'), ('Question', 'Paragraphe 2') , ('Question', 'Paragraphe 3')]

reranker = FlagReranker('antoinelouis/crossencoder-mMiniLMv2-L12-mmarcoFR')
scores = reranker.compute_score(pairs)
print(scores)

Using HuggingFace Transformers

import torch
from transformers import AutoTokenizer, AutoModelForSequenceClassification

pairs = [('Question', 'Paragraphe 1'), ('Question', 'Paragraphe 2') , ('Question', 'Paragraphe 3')]

tokenizer = AutoTokenizer.from_pretrained('antoinelouis/crossencoder-mMiniLMv2-L12-mmarcoFR')
model = AutoModelForSequenceClassification.from_pretrained('antoinelouis/crossencoder-mMiniLMv2-L12-mmarcoFR')
model.eval()

with torch.no_grad():
    inputs = tokenizer(pairs, padding=True, truncation=True, return_tensors='pt', max_length=512)
    scores = model(**inputs, return_dict=True).logits.view(-1, ).float()
print(scores)

📚 Documentation

Evaluation

The model is evaluated on the smaller development set of mMARCO-fr, which consists of 6,980 queries. An ensemble of 1000 passages containing the positive(s) and ColBERTv2 hard negatives need to be reranked. We report the mean reciprocal rank (MRR) and recall at various cut-offs (R@k). To see how it compares to other neural retrievers in French, check out the DécouvrIR leaderboard.

Training

Data

We use the French training samples from the mMARCO dataset, a multilingual machine-translated version of MS MARCO that contains 8.8M passages and 539K training queries. We do not use the BM25 negatives provided by the official dataset but instead sample harder negatives mined from 12 distinct dense retrievers, using the msmarco-hard-negatives distillation dataset. Eventually, we sample 2.6M training triplets of the form (query, passage, relevance) with a positive-to-negative ratio of 1 (i.e., 50% of the pairs are relevant and 50% are irrelevant).

Implementation

The model is initialized from the nreimers/mMiniLMv2-L12-H384-distilled-from-XLMR-Large checkpoint and optimized via the binary cross-entropy loss (as in monoBERT). It is fine-tuned on one 80GB NVIDIA H100 GPU for 20k steps using the AdamW optimizer with a batch size of 128 and a constant learning rate of 2e-5. We set the maximum sequence length of the concatenated question-passage pairs to 256 tokens. We use the sigmoid function to get scores between 0 and 1.

🔧 Technical Details

📄 License

This project is licensed under the MIT license.

📚 Citation

@online{louis2024decouvrir,
	author    = 'Antoine Louis',
	title     = 'DécouvrIR: A Benchmark for Evaluating the Robustness of Information Retrieval Models in French',
	publisher = 'Hugging Face',
	month     = 'mar',
	year      = '2024',
	url       = 'https://huggingface.co/spaces/antoinelouis/decouvrir',
}