From 3f61b3020c0c9bf6a9469b92ff6b62113c6aa5ba Mon Sep 17 00:00:00 2001
From: JB Polle <jbpolle83@gmail.com>
Date: Fri, 12 Mar 2021 14:57:03 +0000
Subject: [PATCH] Update README.md

---
 README.md | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index aeac655..f3f93ec 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,8 @@ widget:
 
 ## Introduction
 
-[camembert-ner] is a NER model that was fine-tuned from camemBERT on wikiner-fr dataset
+[camembert-ner] is a NER model that was fine-tuned from camemBERT on wikiner-fr dataset.
+Model was trained on subset of wikiner-fr dataset (~36 000 sentences)
 
 
 ## How to use camembert-ner with HuggingFace
@@ -74,7 +75,26 @@ nlp("Apple est créée le 1er avril 1976 dans le garage de la maison d'enfance d
 ```
 
 
-## Authors 
+## Model performances
 
+Global
+```
+'precision': 0.8852223816355811
+'recall': 0.8977156991124691
+'f1': 0.8914252690890703
+```
 
+By entity
+```
+'PER': {'precision': 0.9367143476376246,
+        'recall': 0.9583148558758315,
+        'f1': 0.9473914949583516,
+        'number': 2255},
+'MISC': {'precision': 0.831053901850362,
+         'recall': 0.815955766192733,
+         'f1': 0.823435631725787},
+'LOC': {'precision': 0.8701754385964913,
+        'recall': 0.8878281622911695,
+        'f1': 0.8789131718842291}
+  ```