---
library_name: transformers
tags:
- cross-encoder
---

# Model Card for Model ID

<!-- Provide a quick summary of what the model is/does. -->



## Model Details

### Model Description

<!-- Provide a longer summary of what this model is. -->

This cross-encoder is designed for the French RAG system to detect the relevance between questions and their context. Its evaluation is done using CEBinaryClassificationEvaluator. The model is based on the distilroberta-base architecture and fine-tuned on the LeviatanAIResearch/cross-encoder-binary-context-quesion-v2 French dataset. After 4 training epochs, the model achieved a average precision of 0.9951 on the test set. <br/>
This cross-encoder hasn't been trained on similarity datasets similar to STSB. Consequently, the evaluation Spearman correlation on the STS-B development set through CECorrelationEvaluator is 0.699, and on the test set, it is 0.591. The evaluation Pearson correlation on the development set is 0.526, and on the test set, it is 0.423.
- **Developed by:** Leviatan Research Team
- **Model type:** Cross Encoder
- **Language(s) (NLP):** French
- **Finetuned from model [optional]:** distilroberta-base https://huggingface.co/distilbert/distilroberta-base

## Uses
```
! pip install sentencepiece
! pip install sentence-transformers
```

```
from sentence_transformers.cross_encoder import CrossEncoder
from huggingface_hub import login
login(os.getenv('HF_TOKEN'))
model_path = 'LeviatanAIResearch/cross-encoder-context-question-fr-v2'
model =  CrossEncoder(model_path, max_length=512)

scores = model.predict([
    ('Un avion est en train de décoller.', "Un homme joue d'une grande flûte."), 
    ('Un homme coupe une poisson.', 'Un homme coupe une poisson en tranche.'),
    ("Un homme étale du fromage râpé sur une pizza.", "Une personne jette un chat au plafond"),
    (
        "Quelle eau pour la préparation du biberon ?", 
        "Les meilleurs aliments pour nourrir votre bébé sont le lait maternel ou le lait maternisé, les purées de légumes et de fruits, les céréales pour bébés enrichies en fer, les viandes maigres, les poissons riches en oméga-3, etc. Il est important de proposer une variété d'aliments sains pour assurer un bon développement et une nutrition optimale de votre bébé."
    ),
    (
        "Quelle eau pour la préparation du biberon ?",
        "L'image montre une publicité pour un coffret naissance gratuit contenant divers produits destinés aux bébés, comme des couches, un biberon et des soins, accompagnée d'un appel à l'action pour s'inscrire et découvrir où récupérer le cadeau."
    ),
    (
        "Quelle eau pour la préparation du biberon ?",
        "La publicité montre un adulte et un bébé, le bébé tenant un biberon, avec un fond partagé entre une image et un message marketing qui questionne sur le choix de l'eau pour les nourrissons, mettant en avant la marque Mont Roucous comme un accompagnement dans la maternité."
    )
])
print(scores)
```

## Training Details

### Training Data

- evaluator=CEBinaryClassificationEvaluator
- epochs=4
- batch_size=16
- evaluation_steps=5000
- warmup_steps=5868 (10% of train data for warm-up)
- save_best_model=True
- Furthermore, all other hyperparameters are set to their default values.


## Evaluation
- LeviatanAIResearch/cross-encoder-context-question-fr-v2 Test set：
    - Metric: CEBinaryClassificationEvaluator
    - Accuracy:           97.71 (Threshold: 0.9759)
    - F1:                 97.70 (Threshold: 0.9746)
    - Precision:          98.03
    - Recall:             97.36
    - Average Precision:  99.51

- STSD Dev set:
  - Metric : CECorrelationEvaluator
  - Correlation :
    - Pearson: 0.525756
    - Spearman: 0.698986

- STSD Test set:
  - Metric : CECorrelationEvaluator
  - Correlation :
    - Pearson: 0.42251
    - Spearman: 0.590785