Update README.md

README.md

@@ -1,3 +1,36 @@
 ---
+language: en
 license: cc
+tags:
+- named-entity-recognition
+- token-classification
+task: 
+- named-entity-recognition
+- token-classification
+datasets: ncbi_disease
+metrics:
+- precision
+- recall
+- f1
+- accuracy
 ---
+
+## Model information:
+microsoft/BiomedNLP-PubMedBERT-base-uncased-abstract model finetuned using the ncbi_disease dataset from the datasets library. 
+
+## Intended uses:
+This model is intended to be used for named entity recoginition tasks. The model will identify disease entities in text.  The model will predict lables based upon the NCBI-disease dataset, please see the dataset information for details.
+
+## Limitations:
+Note that the dataset and model may not be fully represetative or suitable for all needs it is recommended that the paper for the dataset and the base model card should be reviewed before using the model - 
+- [NCBI Disease](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC3951655/pdf/nihms557856.pdf)
+- [microsoft/BiomedNLP-PubMedBERT-base-uncased-abstract-ft-ncbi-disease](https://huggingface.co/microsoft/BiomedNLP-PubMedBERT-base-uncased-abstract)
+
+
+## How to use:
+Load the model from the library using the following checkpoints:
+```python
+from transformers import AutoTokenizer, AutoModel
+tokenizer = AutoTokenizer.from_pretrained("sarahmiller137/BiomedNLP-PubMedBERT-base-uncased-abstract-ft-ncbi-disease")
+model = AutoModel.from_pretrained("sarahmiller137/BiomedNLP-PubMedBERT-base-uncased-abstract-ft-ncbi-disease")
+```