Update README.md

README.md

@@ -18,12 +18,12 @@ This is a [sentence-transformers](https://www.SBERT.net) model trained. It maps
 
 ### Model Description
 - **Model Type:** Sentence Transformer
-<!-- - **Base model:** [Unknown](https://huggingface.co/unknown) -->
+- **Base model:** [BAAI/bge-m3](https://huggingface.co/BAAI/bge-m3)
 - **Maximum Sequence Length:** 512 tokens
 - **Output Dimensionality:** 1024 tokens
 - **Similarity Function:** Cosine Similarity
-<!-- - **Training Dataset:** Unknown -->
-<!-- - **Language:** Unknown -->
+- **Training Dataset:** [crazyjeannot/fr_literary_dataset_base](https://huggingface.co/datasets/crazyjeannot/fr_literary_dataset_base)
+- **Language:** French
 <!-- - **License:** Unknown -->
 
 ### Model Sources
@@ -74,42 +74,6 @@ print(similarities.shape)
 # [3, 3]
 ```
 
-<!--
-### Direct Usage (Transformers)
-
-<details><summary>Click to see the direct usage in Transformers</summary>
-
-</details>
--->
-
-<!--
-### Downstream Usage (Sentence Transformers)
-
-You can finetune this model on your own dataset.
-
-<details><summary>Click to expand</summary>
-
-</details>
--->
-
-<!--
-### Out-of-Scope Use
-
-*List how the model may foreseeably be misused and address what users ought not to do with the model.*
--->
-
-<!--
-## Bias, Risks and Limitations
-
-*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
--->
-
-<!--
-### Recommendations
-
-*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
--->
-
 ## Training Details
 
 ### Framework Versions
@@ -123,22 +87,17 @@ You can finetune this model on your own dataset.
 
 ## Citation
 
-### BibTeX
-
-<!--
-## Glossary
-
-*Clearly define terms in order to be accessible across audiences.*
--->
+If you find this repository useful, please consider giving a star :star: and citation
 
-<!--
-## Model Card Authors
-
-*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
--->
-
-<!--
-## Model Card Contact
-
-*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
--->
+```
+@inproceedings{barre_latent_2024,
+      title={Latent {Structures} of {Intertextuality} in {French} {Fiction}}, 
+      author={Barré, Jean},
+      address = {Aarhus, Denmark},
+      series = {{CEUR} {Workshop} {Proceedings}},
+      booktitle = {Proceedings of the {Conference} on {Computational} {Humanities} {Research} CHR2024},
+      publisher = {CEUR},
+      editor = {Haverals, Wouter and Koolen, Marijn and Thompson, Laure},
+      year = {2024},
+}
+```