Update README.md

README.md

@@ -7,27 +7,46 @@ datasets:
 metrics:
 - recall
 tags:
-- feature-extraction
-- sentence-similarity
+- passage-retrieval
 library_name: sentence-transformers
+base_model: antoinelouis/camembert-L10
+model-index:
+- name: biencoder-camembert-L10-mmarcoFR
+  results:
+    - task:
+        type: sentence-similarity
+        name: Passage Retrieval
+      dataset:
+        type: unicamp-dl/mmarco
+        name: mMARCO-fr
+        config: french
+        split: validation
+      metrics:
+        - type: recall_at_500
+          name: Recall@500
+          value: 87.8
+        - type: recall_at_100
+          name: Recall@100
+          value: 76.7
+        - type: recall_at_10
+          name: Recall@10
+          value: 49.5
+        - type: mrr_at_10
+          name: MRR@10
+          value: 27.5
+        - type: ndcg_at_10
+          name: nDCG@10
+          value: 32.5
+        - type: map_at_10
+          name: MAP@10
+          value: 27.0
 ---
 
-<h1 align="center">biencoder-camembert-L10-mmarcoFR</h1>
+# biencoder-camembert-L10-mmarcoFR
 
-
-<h4 align="center">
-  <p>
-      <a href=#usage>🛠️ Usage</a>  |
-      <a href="#evaluation">📊 Evaluation</a> |
-      <a href="#train">🤖 Training</a> |
-      <a href="#citation">🔗 Citation</a>
-  <p>
-</h4>
-
-This is a [sentence-transformers](https://www.SBERT.net) model. It maps questions and paragraphs 768-dimensional dense vectors and should be used for semantic search. 
+This is a lightweight dense single-vector bi-encoder model for French. It maps questions and paragraphs 768-dimensional dense vectors and should be used for semantic search. 
 The model uses an [CamemBERT-L10](https://huggingface.co/antoinelouis/camembert-L10) backbone, which is a pruned version of the pre-trained [CamemBERT](https://huggingface.co/camembert-base) 
-checkpoint with 13% less parameters, obtained by [dropping the top-layers](https://doi.org/10.48550/arXiv.2004.03844) from the original model. 
-The model was trained on the **French** portion of the [mMARCO](https://huggingface.co/datasets/unicamp-dl/mmarco) retrieval dataset.
+checkpoint with 13% less parameters, obtained by [dropping the top-layers](https://doi.org/10.48550/arXiv.2004.03844) from the original model.
 
 ## Usage