Update README.md

README.md

@@ -8,4 +8,70 @@ metrics:
 - f1
 library_name: transformers
 pipeline_tag: token-classification
----
+---
+# PuoBERTa-NER: A Setswana Langage Model Finetuned on MasakhaNER-2 for Named Entity Recognition.
+
+A Roberta-based language model finetuned on MasakhaneNER-2 for Named Entity Recognition.
+
+Based on [https://huggingface.co/dsfsi/PuoBERTa](https://huggingface.co/dsfsi/PuoBERTa)
+
+## Model Details
+
+### Model Description
+
+This is a POS model trained on Setswana based on PuoBERTa and fineruned on MasakhaNER-2 Setswana.
+
+- **Developed by:** Vukosi Marivate ([@vukosi](https://huggingface.co/@vukosi)), Moseli Mots'Oehli ([@MoseliMotsoehli](https://huggingface.co/@MoseliMotsoehli)) , Valencia Wagner, Richard Lastrucci and Isheanesu Dzingirai
+- **Model type:** RoBERTa Model
+- **Language(s) (NLP):** Setswana
+- **License:** CC BY 4.0
+
+### Model Performance
+
+Performance of models on the [MasakhaNER-2](https://github.com/masakhane-io/masakhane-ner/tree/main/MasakhaNER2.0) downstream task.
+
+| Model | Test Performance (f1 score) |
+|---|---|
+| **Multilingual Models** |  |
+| AfriBERTa | 83.2 |
+| AfroXLMR-base | 87.7 |
+| AfroXLMR-large | 89.4 |
+| **Monolingual Models** |  |
+| NCHLT TSN RoBERTa | 74.2 |
+| PuoBERTa | **78.2** |
+| PuoBERTa+JW300 | **80.2** |
+
+### Usage
+
+Use this model for Part of Speech Tagging for Setswana.
+```python
+
+```
+
+## Citation Information
+
+Bibtex Refrence
+
+```
+@article{marivatePuoBERTa2023,
+  title={PuoBERTa: Training and evaluation of a curated language model for Setswana},
+  author={Vukosi Marivate and Moseli Mots'Oehli and Valencia Wagner and Richard Lastrucci and Isheanesu Dzingirai},
+  journal={ArXiv},
+}
+```
+
+## Contributing
+
+Your contributions are welcome! Feel free to improve the model.
+
+## Model Card Authors
+
+Vukosi Marivate
+
+## Model Card Contact
+
+For more details, reach out or check our [website](https://dsfsi.github.io/).
+
+Email: vukosi.marivate@cs.up.ac.za
+
+**Enjoy exploring Setswana through AI!**