Crossencoder Camembert Base Mmarcofr

🚀 crossencoder-camembert-base-mmarcoFR

This is a cross-encoder model for French. It conducts cross-attention between a question - passage pair and outputs a relevance score. The model can be used as a reranker for semantic search, sorting passages based on the predicted relevance scores.

🚀 Quick Start

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

💻 Usage Examples

[Basic Usage]

Using Sentence-Transformers

Start by installing the library: pip install -U sentence-transformers. Then, you can use the model like this:

from sentence_transformers import CrossEncoder

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

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

Using FlagEmbedding

Start by installing the library: pip install -U FlagEmbedding. Then, you can use the model like this:

from FlagEmbedding import FlagReranker

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

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

Using HuggingFace Transformers

Start by installing the library: pip install -U transformers. Then, you can use the model like this:

import torch
from transformers import AutoTokenizer, AutoModelForSequenceClassification

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

tokenizer = AutoTokenizer.from_pretrained('antoinelouis/crossencoder-camembert-base-mmarcoFR')
model = AutoModelForSequenceClassification.from_pretrained('antoinelouis/crossencoder-camembert-base-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 for which 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 almanach/camembert-base 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.

📄 License

The model is released under the MIT license.

📊 Model Information

📈 Model Index

📖 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',
}