add draft of readme.md

README.md

@@ -1,3 +1,33 @@
 ---
+language: 
+  - en
+
+tags:
+- pytorch
+- ner
+- qa
+
 license: mit
+
+datasets:
+- conll2003
+
+metrics:
+- f1
 ---
+# t5-base-qa-ner-conll
+
+Unofficial implementation of [InstructionNER](https://arxiv.org/pdf/2203.03903v1.pdf).
+t5-base model tuned on conll2003 dataset.
+
+https://github.com/ovbystrova/InstructionNER 
+
+## Prediction Sample
+```
+Sentence: The protest , which attracted several thousand supporters , coincided with the 18th anniversary of Spain 's constitution .
+Instruction: please extract entities and their types from the input sentence, all entity types are in options
+Options: ORG, PER, LOC
+
+Prediction (raw text): Spain is a LOC.
+```
+