Update README.md

README.md

@@ -4,8 +4,52 @@ tags:
 - token-classification
 - sequence-tagger-model
 language: fa
+dataset:
+-  NSURL-2019
 widget:
 - text: "آخرین مقام برجسته ژاپنی که پس از انقلاب 57  تاکنون به ایران سفر کرده است شینتارو آبه است."
 ---
 
-## Persian NER in Flair
+## Persian NER in Flair
+
+This is the universal Named-entity recognition model for Persian that ships with [Flair](https://github.com/flairNLP/flair/).
+
+F1-Score: **??** (NSURL-2019)
+
+Predicts NER tags:
+
+| **tag**                        | **meaning** |
+|:---------------------------------:|:-----------:|
+| PER         | person name | 
+| LOC         | location name | 
+| ORG         | organization name | 
+| DAT         | date |
+| TIM         | time |
+| PCT         | percent |
+| MON         | Money|
+
+---
+
+### Demo: How to use in Flair
+
+Requires: **[Flair](https://github.com/flairNLP/flair/)** (`pip install flair`)
+
+```python
+from flair.data import Sentence
+from flair.models import SequenceTagger
+
+# load tagger
+tagger = SequenceTagger.load("hamedkhaledi/persain-flair-ner")
+
+# make example sentence
+sentence = Sentence("آخرین مقام برجسته ژاپنی که پس از انقلاب 57  تاکنون به ایران سفر کرده است شینتارو آبه است.")
+
+tagger.predict(sentence)
+#print result
+print(sentence.to_tagged_string())
+```
+
+This yields the following output:
+```
+آخرین مقام برجسته ژاپنی که پس از انقلاب 57 <B-DAT> تاکنون به ایران <B-LOC> سفر کرده است شینتارو <B-PER> آبه <I-PER> است .
+```