adding Naija XLMR

README.md

@@ -0,0 +1,42 @@
+Hugging Face's logo
+---
+language: rw
+datasets:
+
+---
+# xlm-roberta-base-finetuned-kinyarwanda
+## Model description
+**xlm-roberta-base-finetuned-kinyarwanda** is a **Kinyarwanda RoBERTa** model obtained by fine-tuning **xlm-roberta-base** model on Kinyarwanda language texts.  It provides **better performance** than the XLM-RoBERTa on named entity recognition datasets.  
+
+Specifically, this model is a *xlm-roberta-base* model that was fine-tuned on Kinyarwanda corpus. 
+## Intended uses & limitations
+#### How to use
+You can use this model with Transformers *pipeline* for masked token prediction.
+```python
+>>> from transformers import pipeline
+>>> unmasker = pipeline('fill-mask', model='Davlan/xlm-roberta-base-finetuned-kinyarwanda')
+>>> unmasker("Twabonye ko igihe mu <mask> hazaba hari ikirango abantu bakunze")
+
+
+
+```
+#### Limitations and bias
+This model is limited by its training dataset of entity-annotated news articles from a specific span of time. This may not generalize well for all use cases in different domains. 
+## Training data
+This model was fine-tuned on JW300 + [KIRNEWS](https://github.com/Andrews2017/KINNEWS-and-KIRNEWS-Corpus) + [BBC Gahuza](https://www.bbc.com/gahuza)
+
+## Training procedure
+This model was trained on a single NVIDIA V100 GPU
+
+## Eval results on Test set (F-score, average over 5 runs)
+Dataset| XLM-R F1 | rw_roberta F1
+-|-|-
+[MasakhaNER](https://github.com/masakhane-io/masakhane-ner) | 73.22 | 77.76
+
+### BibTeX entry and citation info
+By David Adelani
+```
+
+```
+
+

config.json

@@ -0,0 +1,27 @@
+{
+  "_name_or_path": "xlm-roberta-base",
+  "architectures": [
+    "XLMRobertaForMaskedLM"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "bos_token_id": 0,
+  "eos_token_id": 2,
+  "gradient_checkpointing": false,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 768,
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "layer_norm_eps": 1e-05,
+  "max_position_embeddings": 514,
+  "model_type": "xlm-roberta",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "output_past": true,
+  "pad_token_id": 1,
+  "position_embedding_type": "absolute",
+  "transformers_version": "4.4.2",
+  "type_vocab_size": 1,
+  "use_cache": true,
+  "vocab_size": 250002
+}

pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:841b2abf581f39e132c99e395f8af9666e443f95f0d75f7d29192544f1811a11
+size 1113271890

sentencepiece.bpe.model

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:cfc8146abe2a0488e9e2a0c56de7952f7c11ab059eca145a0a727afce0db2865
+size 5069051

special_tokens_map.json

@@ -0,0 +1 @@
+{"bos_token": "<s>", "eos_token": "</s>", "unk_token": "<unk>", "sep_token": "</s>", "pad_token": "<pad>", "cls_token": "<s>", "mask_token": {"content": "<mask>", "single_word": false, "lstrip": true, "rstrip": false, "normalized": false}}

tokenizer_config.json

@@ -0,0 +1 @@
+{"bos_token": "<s>", "eos_token": "</s>", "sep_token": "</s>", "cls_token": "<s>", "unk_token": "<unk>", "pad_token": "<pad>", "mask_token": {"content": "<mask>", "single_word": false, "lstrip": true, "rstrip": false, "normalized": true, "__type": "AddedToken"}, "model_max_length": 512, "special_tokens_map_file": null, "name_or_path": "xlm-roberta-base"}

training_args.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:df86a7918313b4c74d266021bc73f8aa39c68f4474e81f1a9b972ef3063d2cc8
+size 2287