Update README.md

README.md

@@ -3,52 +3,42 @@ license: mit
 tags:
 - generated_from_trainer
 model-index:
-- name: afro_xlmr
+- name: afro-xlmr-base
   results: []
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
 
-# afro_xlmr
+# afro-xlmr-base
+
+AfroXLMR-base was created by MLM adaptation of XLM-R-base model on 17 African languages (Afrikaans, Amharic, Hausa, Igbo, Malagasy, Chichewa, Oromo, Naija, Kinyarwanda, Kirundi, Shona, Somali, Sesotho, Swahili, isiXhosa, Yoruba, and isiZulu) covering the major African language families and 3 high resource languages (Arabic, French, and English). 
+
+## Eval results on MasakhaNER (F-score)
+language| XLM-R-miniLM| XLM-R-base |XLM-R-large| afro-xlmr-base | afro-xlmr-small | afro-xlmr-mini
+-|-|-|-|-
+amh |69.5|70.6|76.2|76.1|70.1|69.7
+hau |74.5|89.5|90.5|91.2|91.4|87.7
+ibo |81.9|84.8|84.1|87.4|86.6|83.5
+kin |68.6|73.3|73.8|78.0|77.5|74.1
+lug |64.7|79.7|81.6|82.9|83.2|77.4
+luo |11.7|74.9|73.6|75.1|75.4|17.5
+pcm |83.2|87.3|89.0|89.6|89.0|85.5
+swa |86.3|87.4|89.4|88.6|88.7|86.0
+wol |51.7|63.9|67.9|67.4|65.9|59.0
+yor |72.0|78.3|78.9|82.1|81.3|75.1
+
+### BibTeX entry and citation info
+```
+@misc{afro_maft,
+  doi = {10.48550/ARXIV.2204.06487},
+  url = {https://arxiv.org/abs/2204.06487},
+  author = {Alabi, Jesujoba O. and Adelani, David Ifeoluwa and Mosbach, Marius and Klakow, Dietrich},
+  keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
+  title = {Multilingual Language Model Adaptive Fine-Tuning: A Study on African Languages},
+  publisher = {arXiv},
+  year = {2022},
+  copyright = {Creative Commons Attribution 4.0 International}
+}
+
+```
 
-This model is a fine-tuned version of [xlm-roberta-base](https://huggingface.co/xlm-roberta-base) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 1.4282
 
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
-## Training procedure
-
-### Training hyperparameters
-
-The following hyperparameters were used during training:
-- learning_rate: 5e-05
-- train_batch_size: 10
-- eval_batch_size: 8
-- seed: 42
-- distributed_type: multi-GPU
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: linear
-- num_epochs: 3.0
-
-### Training results
-
-
-
-### Framework versions
-
-- Transformers 4.13.0
-- Pytorch 1.7.1+cu110
-- Datasets 1.16.1
-- Tokenizers 0.10.3