Update README.md

README.md

@@ -1,6 +1,8 @@
 ---
-datasets: []
-language: []
+datasets:
+- crazyjeannot/fr_literary_dataset_base
+language:
+- fr
 library_name: sentence-transformers
 pipeline_tag: sentence-similarity
 tags:
@@ -8,11 +10,19 @@ tags:
 - sentence-similarity
 - feature-extraction
 widget: []
+license: cc-by-2.5
+base_model:
+- BAAI/bge-m3
 ---
 
-# SentenceTransformer
+# Literary Encoder
+
+This is an encoder model finetuned from the FlagOpen/FlagEmbedding family of models.
+
+The model is specialized for studying french literary fiction with a training corpora based on 40.000 passages from free from rights french literary novels.
+
+It maps paragraphs to a 1024-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
 
-This is a [sentence-transformers](https://www.SBERT.net) model trained. It maps sentences & paragraphs to a 1024-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
 
 ## Model Details
 
@@ -24,13 +34,13 @@ This is a [sentence-transformers](https://www.SBERT.net) model trained. It maps
 - **Similarity Function:** Cosine Similarity
 - **Training Dataset:** [crazyjeannot/fr_literary_dataset_base](https://huggingface.co/datasets/crazyjeannot/fr_literary_dataset_base)
 - **Language:** French
-<!-- - **License:** Unknown -->
+- **License:** cc-by-2.5
 
 ### Model Sources
 
 - **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
-- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
-- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
+- **Repository:** [Flag Embedding on GitHub](https://github.com/FlagOpen/FlagEmbedding)
+- **Hugging Face:** [BGE dense model on Hugging Face](https://huggingface.co/BAAI/bge-m3)
 
 ### Full Model Architecture
 
@@ -44,34 +54,46 @@ SentenceTransformer(
 
 ## Usage
 
-### Direct Usage (Sentence Transformers)
+### Direct Usage (FlagEmbedding)
 
-First install the Sentence Transformers library:
+Then you can load this model and run inference.
+```python
+from FlagEmbedding import FlagModel
 
-```bash
-pip install -U sentence-transformers
+# Download from the 🤗 Hub
+model = FlagModel('crazyjeannot/literary_bge_base',
+                  query_instruction_for_retrieval="Represent this sentence for searching relevant passages:",
+                  use_fp16=True)
+
+# Run inference
+sentences = [
+    'Il y avait, du reste, cette chose assez triste, c’est que si M. de Marsantes, à l’esprit fort ouvert, eût apprécié un fils si différent de lui, Robert de Saint-Loup, parce qu’il était de ceux qui croient que le mérite est attaché à certaines formes de la vie, avait un souvenir affectueux mais un peu méprisant d’un père qui s’était occupé toute sa vie de chasse et de course, avait bâillé à Wagner et raffolé d’Offenbach.',
+    "D’ailleurs, les opinions tranchantes abondent dans un siècle où l’on ne doute de rien, hors de l’existence de Dieu ; mais comme les jugements généraux que l’on porte sur les peuples sont assez souvent démentis par l’expérience, je n’aurai garde de prononcer.",
+    'Il était chargé de remettre l’objet, quel qu’il fût, au commodore, et d’en prendre un reçu, comme preuve que lui et son camarade s’étaient acquittés de leur commission.',
+]
+embeddings = model.encode(sentences)
+print(embeddings.shape)
+# [3, 1024]
 ```
 
-Then you can load this model and run inference.
+### SentenceTransformer
+
 ```python
 from sentence_transformers import SentenceTransformer
 
 # Download from the 🤗 Hub
 model = SentenceTransformer("sentence_transformers_model_id")
+
 # Run inference
 sentences = [
-    'The weather is lovely today.',
-    "It's so sunny outside!",
-    'He drove to the stadium.',
+    'Il y avait, du reste, cette chose assez triste, c’est que si M. de Marsantes, à l’esprit fort ouvert, eût apprécié un fils si différent de lui, Robert de Saint-Loup, parce qu’il était de ceux qui croient que le mérite est attaché à certaines formes de la vie, avait un souvenir affectueux mais un peu méprisant d’un père qui s’était occupé toute sa vie de chasse et de course, avait bâillé à Wagner et raffolé d’Offenbach.',
+    "D’ailleurs, les opinions tranchantes abondent dans un siècle où l’on ne doute de rien, hors de l’existence de Dieu ; mais comme les jugements généraux que l’on porte sur les peuples sont assez souvent démentis par l’expérience, je n’aurai garde de prononcer.",
+    'Il était chargé de remettre l’objet, quel qu’il fût, au commodore, et d’en prendre un reçu, comme preuve que lui et son camarade s’étaient acquittés de leur commission.',
 ]
+
 embeddings = model.encode(sentences)
 print(embeddings.shape)
 # [3, 1024]
-
-# Get the similarity scores for the embeddings
-similarities = model.similarity(embeddings, embeddings)
-print(similarities.shape)
-# [3, 3]
 ```
 
 ## Training Details