From 08b92f78fa39070e74c3c58627bb60ff87e71945 Mon Sep 17 00:00:00 2001
From: Karthik Uppuluri <karthik.uppuluri@gmail.com>
Date: Fri, 6 Nov 2020 00:25:33 -0800
Subject: [PATCH] Create README.md (#8168)

* Create README.md

* Update README.md
---
 .../kuppuluri/telugu_bertu_ner/README.md      | 35 +++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 model_cards/kuppuluri/telugu_bertu_ner/README.md

diff --git a/model_cards/kuppuluri/telugu_bertu_ner/README.md b/model_cards/kuppuluri/telugu_bertu_ner/README.md
new file mode 100644
index 0000000000..39cf5bd087
--- /dev/null
+++ b/model_cards/kuppuluri/telugu_bertu_ner/README.md
@@ -0,0 +1,35 @@
+# Named Entity Recognition Model for Telugu
+
+#### How to use
+
+```python
+from simpletransformers.ner import NERModel
+model = NERModel('bert',
+                 'kuppuluri/telugu_bertu_ner',
+                 labels=[
+                     'B-PERSON', 'I-ORG', 'B-ORG', 'I-LOC', 'B-MISC',
+                     'I-MISC', 'I-PERSON', 'B-LOC', 'O'
+                 ],
+                 use_cuda=False,
+                 args={"use_multiprocessing": False})
+
+text = "విరాట్ కోహ్లీ కూడా అదే నిర్లక్ష్యాన్ని ప్రదర్శించి కేవలం ఒక పరుగుకే రనౌటై పెవిలియన్ చేరాడు ."
+results = model.predict([text])
+```
+
+## Training data
+
+Training data is from https://github.com/anikethjr/NER_Telugu
+
+## Eval results
+
+On the test set my results were
+
+eval_loss = 0.0004407190410447974
+
+f1_score = 0.999519076627124
+
+precision = 0.9994389677005691
+
+recall = 0.9995991983967936
+