Update README.md

README.md

@@ -1,5 +1,43 @@
-BEST QA model on hugging face with  on fquad test set !
+---
+
+language: 
+- fr
+tags:
+- fr
+
+---
+Best french QA model shared on HF!
+
+
+### FQuAD Evaluation
+```shell
+{'exact_match': 57.214554579673774, 'f1': 80.75789384679857}''
+```
+
+## Usage
+
+```python
+from transformers import pipeline
+
+nlp = pipeline('question-answering', model='CATIE-AQ/camembert_fquad_squad2fr_piafs_newsquadfr', tokenizer='CATIE-AQ/camembert_fquad_squad2fr_piafs_newsquadfr')
+
+nlp({
+    'question': "Qui est Claude Monet?",
+    'context': "Claude Monet, né le 14 novembre 1840 à Paris et mort le 5 décembre 1926 à Giverny, est un peintre français et l’un des fondateurs de l'impressionnisme."
+})
+```
+
+
+This model was trained on our servers with several datasets :
+- fquad
+- squad2fr (traduction from squad2 de pragnakalp)
+- piaf 1.0+1.1+1.2
+- newsquadfr
+
+
+
+The CATIE (Centre Aquitain des Technologies de l'Information et Électroniques) is a center for technologic transfer specialized in digital technologies. 
+CATIE has a multidisciplinary approach through three fields of action : human factors and cognition, digital systems and AI.
+https://www.catie.fr/en/home/
+
 
-# FQUAD test set :
-'''shell
-{'exact_match': 57.214554579673774, 'f1': 80.75789384679857}''