Update README.md

README.md

@@ -1,45 +1,125 @@
 ---
 license: mit
 base_model: camembert-base
-tags:
-- generated_from_trainer
 metrics:
 - precision
 - recall
 - f1
 - accuracy
 model-index:
-- name: camembert-base-frenchNER-3_epochs
+- name: Camembert-NER-base-frenchNER
   results: []
+datasets:
+- CATIE-AQ/frenchNER
+language:
+- fr
+widget:
+- text: "Boulanger, habitant à Boulanger et travaillant dans le magasin Boulanger situé dans la ville de Boulanger. Boulanger a écrit le livre éponyme Boulanger édité par la maison d'édition Boulanger."
+library_name: transformers
+pipeline_tag: token-classification
+co2_eq_emissions: 35
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
 
-# camembert-base-frenchNER-3_epochs
+# Camembert-NER-base-frenchNER
 
-This model is a fine-tuned version of [camembert-base](https://huggingface.co/camembert-base) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.0876
-- Precision: 0.9292
-- Recall: 0.9534
-- F1: 0.9411
-- Accuracy: 0.9858
+## Model Description
 
-## Model description
+We present **Camembert-NER-base-frenchNER**, which is a [CamemBERT base](https://huggingface.co/camembert-base) fine-tuned for the Name Entity Recognition task for the French language on five French NER datasets for 3 entities (LOC, PER, ORG).  
+All these datasets were concatenated and cleaned into a single dataset that we called [frenchNER](https://huggingface.co/datasets/CATIE-AQ/frenchNER).  
+This represents a total of over **420,264 rows, of which 346,071 are for training, 32,951 for validation and 41,242 for testing.**.  
+Our methodology is described in a blog post available in [English](https://blog.vaniila.ai/en/NER_en/) or [French](https://blog.vaniila.ai/NER/).
 
-More information needed
 
-## Intended uses & limitations
 
-More information needed
+## Dataset
 
-## Training and evaluation data
+The dataset used is [frenchNER](https://huggingface.co/datasets/CATIE-AQ/frenchNER), which represents ~420k sentences labeled in 4 categories :
+* PER: personality ;
+* LOC: location ;
+* ORG: organization ;
+* O: background (Outside entity).
 
-More information needed
+The distribution of the entities is as follows:
 
-## Training procedure
+<table>
+<thead>
+  <tr>
+    <th><br>Splits</th>
+    <th><br>O</th>
+    <th><br>PER</th>
+    <th><br>LOC</th>  
+    <th><br>ORG</th>
+  </tr>
+</thead>
+<tbody>
+    <td><br>train</td>
+    <td><br><b>8,398,765</b></td>
+    <td><br><b>327,393</b></td>
+    <td><br><b>303,722</b></td>
+    <td><br><b>151,490</b></td>
+  </tr>
+  <tr>
+    <td><br>validation</td>
+    <td><br><b>592,815</b></td>
+    <td><br><b>34,127</b></td>
+    <td><br><b>30,279</b></td>
+    <td><br><b>18,743</b></td>
+  </tr>
+  <tr>
+    <td><br>test</td>
+    <td><br><b>773,871</b></td>
+    <td><br><b>43,634</b></td>
+    <td><br><b>39,195</b></td>
+    <td><br><b>21,391</b></td>
+  </tr>
+</tbody>
+</table>
+
+
+## Evaluation results
+
+The evaluation was carried out using the [**evaluate**](https://pypi.org/project/evaluate/) python package.
+
+### multiconer
+TODO
+
+### multinerd
+TODO
+
+### wikiann
+TODO
+
+### wikiner
+TODO
+
+### frenchNER
+TODO
+
+## Usage
+### Code
+
+```python
+from transformers import pipeline
 
+ner = pipeline('question-answering', model='CATIE-AQ/Camembert-NER-base-frenchNER', tokenizer='CATIE-AQ/Camembert-NER-base-frenchNER', grouped_entities=True)
+
+result = ner(
+"Assurés de disputer l'Euro 2024 en Allemagne l'été prochain (du 14 juin au 14 juillet) depuis leur victoire aux Pays-Bas, les Bleus ont fait le nécessaire pour avoir des certitudes. Avec six victoires en six matchs officiels et un seul but encaissé, Didier Deschamps a consolidé les acquis de la dernière Coupe du monde. Les joueurs clés sont connus : Kylian Mbappé, Aurélien Tchouameni, Antoine Griezmann, Ibrahima Konaté ou encore Mike Maignan.")
+)
+
+print(result)
+```
+```python
+TODO
+```
+
+### Try it through Space
+A Space has been created to test the model. It is available [here](https://huggingface.co/spaces/CATIE-AQ/Camembert-NER).
+
+
+
+## Training procedure
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
@@ -66,3 +146,102 @@ The following hyperparameters were used during training:
 - Pytorch 2.1.1
 - Datasets 2.14.7
 - Tokenizers 0.15.0
+
+
+## Environmental Impact
+
+*Carbon emissions were estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700). The hardware, runtime, cloud provider, and compute region were utilized to estimate the carbon impact.*
+
+- **Hardware Type:** A100 PCIe 40/80GB
+- **Hours used:** 1h45min
+- **Cloud Provider:** Private Infrastructure
+- **Carbon Efficiency (kg/kWh):** 0.079 (estimated from [electricitymaps](https://app.electricitymaps.com/zone/FR) for the day of December 15, 2023.)
+- **Carbon Emitted** *(Power consumption x Time x Carbon produced based on location of power grid)*: 0.035 kg eq. CO2
+
+
+
+## Citations
+
+### Camembert-NER-frenchNER
+```
+TODO
+```
+
+### multiconer
+
+> @inproceedings{multiconer2-report,  
+    title={{SemEval-2023 Task 2: Fine-grained Multilingual Named Entity Recognition (MultiCoNER 2)}},  
+    author={Fetahu, Besnik and Kar, Sudipta and Chen, Zhiyu and Rokhlenko, Oleg and Malmasi, Shervin},  
+    booktitle={Proceedings of the 17th International Workshop on Semantic Evaluation (SemEval-2023)},  
+    year={2023},  
+    publisher={Association for Computational Linguistics}}
+
+> @article{multiconer2-data,  
+    title={{MultiCoNER v2: a Large Multilingual dataset for Fine-grained and Noisy Named Entity Recognition}},  
+    author={Fetahu, Besnik and Chen, Zhiyu and Kar, Sudipta and Rokhlenko, Oleg and Malmasi, Shervin},  
+    year={2023}}
+
+
+### multinerd
+
+> @inproceedings{tedeschi-navigli-2022-multinerd,  
+    title = "{M}ulti{NERD}: A Multilingual, Multi-Genre and Fine-Grained Dataset for Named Entity Recognition (and Disambiguation)",  
+    author = "Tedeschi, Simone and  Navigli, Roberto",  
+    booktitle = "Findings of the Association for Computational Linguistics: NAACL 2022",  
+    month = jul,  
+    year = "2022",  
+    address = "Seattle, United States",  
+    publisher = "Association for Computational Linguistics",  
+    url = "https://aclanthology.org/2022.findings-naacl.60",  
+    doi = "10.18653/v1/2022.findings-naacl.60",  
+    pages = "801--812"}
+
+
+### pii-masking-200k
+```
+TODO
+```
+
+### wikiann
+
+> @inproceedings{rahimi-etal-2019-massively,  
+    title = "Massively Multilingual Transfer for {NER}",  
+    author = "Rahimi, Afshin and Li, Yuan and Cohn, Trevor",  
+    booktitle = "Proceedings of the 57th Annual Meeting of the Association for Computational Linguistics",  
+    month = jul,  
+    year = "2019",  
+    address = "Florence, Italy",  
+    publisher = "Association for Computational Linguistics",  
+    url = "https://www.aclweb.org/anthology/P19-1015",  
+    pages = "151--164"}
+
+### wikiner
+
+> @article{NOTHMAN2013151,  
+title = {Learning multilingual named entity recognition from Wikipedia},  
+journal = {Artificial Intelligence},  
+volume = {194},  
+pages = {151-175},  
+year = {2013},  
+note = {Artificial Intelligence, Wikipedia and Semi-Structured Resources},  
+issn = {0004-3702},  
+doi = {https://doi.org/10.1016/j.artint.2012.03.006},  
+url = {https://www.sciencedirect.com/science/article/pii/S0004370212000276},  
+author = {Joel Nothman and Nicky Ringland and Will Radford and Tara Murphy and James R. Curran}}
+
+
+### frenchNER
+```
+TODO
+```
+
+### CamemBERT
+> @inproceedings{martin2020camembert,  
+  title={CamemBERT: a Tasty French Language Model},  
+  author={Martin, Louis and Muller, Benjamin and Su{\'a}rez, Pedro Javier Ortiz and Dupont, Yoann and Romary, Laurent and de la Clergerie, {\'E}ric Villemonte and Seddah, Djam{\'e} and Sagot, Beno{\^\i}t},  
+  booktitle={Proceedings of the 58th Annual Meeting of the Association for Computational Linguistics},  
+  year={2020}}
+
+
+## License
+ [cc-by-4.0](https://creativecommons.org/licenses/by/4.0/deed.en)