Update README.md

README.md

@@ -8,7 +8,6 @@ widget:
 - text: "Un homme, qui parle à son collègue, <s'> avance vers moi."
 ---
 
-
 # Easter-Island/coref_classifier_ancor
 
 ## Table of Contents
@@ -33,9 +32,108 @@ This model is a state-of-the-art language model for French coreference resolutio
   
 ## Uses
 
-#### Direct Use
+This model can be used for Coreference token classification tasks.
+The model evaluates, for each token, if it is a reference of the expression between "<>".
+
+### Example
+
+```python
+from transformers import pipeline
+classifier = pipeline("ner", model=model, tokenizer=tokenizer)
+
+text = "Un homme me parle. <Il> est beau."
+[elem['word'] for elem in classifier(text) if elem['entity'] == 'LABEL_1']
+# results
+['▁Un', '▁homme']
+```
+
+This coreference resolver can perform many tasks
+
+### Reprise pronominale
+```python
+from transformers import AutoModelForTokenClassification, AutoTokenizer
+
+model = AutoModelForTokenClassification.from_pretrained("models/merged/ancor_classifier")
+tokenizer = AutoTokenizer.from_pretrained("models/merged/ancor_classifier_tokenizer")
+from transformers import pipeline
+classifier = pipeline("ner", model=model, tokenizer=tokenizer)
 
-This model can be used for Token Classification tasks.
+text = "Platon est un philosophe antique de la Grèce classique... Il reprit le travail philosophique decertains de <ses> prédécesseurs"
+[elem['word'] for elem in classifier(text) if elem['entity'] == 'LABEL_1']
+# results
+['▁Platon']
+
+text = "Platon est un philosophe antique de la Grèce classique... <Il> reprit le travail philosophique decertains de ses prédécesseurs"
+[elem['word'] for elem in classifier(text) if elem['entity'] == 'LABEL_1']
+# results
+['▁Platon', '▁un', '▁philosophe', '▁antique', '▁de','▁la', '▁Grèce', '▁classique', '▁ses']
+
+```
+
+### Anaphores fidèles
+```python
+from transformers import pipeline
+classifier = pipeline("ner", model=model, tokenizer=tokenizer)
+
+text = "Le chat que j’ai adopté court partout... Mais j’aime beaucoup <ce chat> ."
+[elem['word'] for elem in classifier(text) if elem['entity'] == 'LABEL_1']
+# results
+['▁Le', '▁chat']
+```
+
+### Anaphores infidèles
+```python
+from transformers import pipeline
+classifier = pipeline("ner", model=model, tokenizer=tokenizer)
+
+text = "Le chat que j’ai adopté court partout... Mais j’aime beaucoup <cet animal> ."
+[elem['word'] for elem in classifier(text) if elem['entity'] == 'LABEL_1']
+# results
+['▁Le', '▁chat']
+```
+
+### Paroles rapportées
+```python
+from transformers import pipeline
+classifier = pipeline("ner", model=model, tokenizer=tokenizer)
+
+text = """Lionel Jospin se livre en revanche à une longue analyse de son échec du 21 avril. “Ma part de responsabilité dans l’échec existe forcément. <Je> l’ai assumée en quittant la vie politique”"""
+[elem['word'] for elem in classifier(text) if elem['entity'] == 'LABEL_1']
+# results
+['▁Lionel', '▁Jos', 'pin', '▁son', 'Ma']
+```
+
+### Entités nommées
+```python
+from transformers import pipeline
+classifier = pipeline("ner", model=model, tokenizer=tokenizer)
+
+text = "Paris est située sur la Seine. <La plus grande ville de France> compte plus de 10 millions d’habitants."
+[elem['word'] for elem in classifier(text) if elem['entity'] == 'LABEL_1']
+# results
+['▁Paris']
+```
+### Les groupes
+```python
+from transformers import pipeline
+classifier = pipeline("ner", model=model, tokenizer=tokenizer)
+
+text = "Jack et Rose commencent à faire connaissance. Ils s’entendent bien. <Le couple> se marie et a des enfants."
+[elem['word'] for elem in classifier(text) if elem['entity'] == 'LABEL_1']
+# results
+['▁Jack', '▁et', '▁Rose', '▁Ils']
+```
+
+### Groupes dispersés
+```python
+from transformers import pipeline
+classifier = pipeline("ner", model=model, tokenizer=tokenizer)
+
+text = "Jack et Rose commencent à faire connaissance. Ils s’entendent bien. <Le couple> se marie et a des enfants."
+[elem['word'] for elem in classifier(text) if elem['entity'] == 'LABEL_1']
+# results
+['▁Jack', '▁et', '▁Rose', '▁Ils']
+```
 
 
 ## Risks, Limitations and Biases