adding Swahili BERT

README.md

@@ -0,0 +1,60 @@
+Hugging Face's logo
+---
+language: ha
+datasets:
+
+---
+# bert-base-multilingual-cased-finetuned-hausa
+## Model description
+**bert-base-multilingual-cased-finetuned-hausa** is a **Hausa BERT** model obtained by fine-tuning **bert-base-multilingual-cased** model on Hausa language texts.  It provides **better performance** than the multilingual BERT on text classification and named entity recognition datasets.  
+
+Specifically, this model is a *bert-base-multilingual-cased* model that was fine-tuned on Hausa 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/bert-base-multilingual-cased-finetuned-hausa')
+>>> unmasker("Shugaban [MASK] Muhammadu Buhari ya amince da shawarar da ma’aikatar sufuri karkashin jagoranci")
+                    
+[{'sequence': 
+'[CLS] Shugaban Nigeria Muhammadu Buhari ya amince da shawarar da ma [UNK] aikatar sufuri karkashin jagoranci [SEP]', 
+'score': 0.9762618541717529, 
+'token': 22045, 
+'token_str': 'Nigeria'}, 
+{'sequence': '[CLS] Shugaban Ka Muhammadu Buhari ya amince da shawarar da ma [UNK] aikatar sufuri karkashin jagoranci [SEP]', 'score': 0.007239189930260181, 
+'token': 25444, 
+'token_str': 'Ka'}, 
+{'sequence': '[CLS] Shugaban, Muhammadu Buhari ya amince da shawarar da ma [UNK] aikatar sufuri karkashin jagoranci [SEP]', 'score': 0.001990817254409194, 
+'token': 117, 
+'token_str': ','}, 
+{'sequence': '[CLS] Shugaban Ghana Muhammadu Buhari ya amince da shawarar da ma [UNK] aikatar sufuri karkashin jagoranci [SEP]', 'score': 0.001566368737258017, 
+'token': 28682, 
+'token_str': 'Ghana'}, 
+{'sequence': '[CLS] Shugabanmu Muhammadu Buhari ya amince da shawarar da ma [UNK] aikatar sufuri karkashin jagoranci [SEP]', 'score': 0.0009375187801197171, 
+'token': 11717, 
+'token_str': '##mu'}]
+
+```
+#### 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 [Hausa CC-100](http://data.statmt.org/cc-100/)
+
+## Training procedure
+This model was trained on a single NVIDIA V100 GPU
+
+## Eval results on Test set (F-score, average over 5 runs)
+Dataset| mBERT F1 | ha_bert F1
+-|-|-
+[Hausa VOA NER](https://huggingface.co/datasets/hausa_voa_ner) | | 
+[MasakhaNER](https://github.com/masakhane-io/masakhane-ner) | 86.65 | 
+[VOA Hausa Textclass](https://huggingface.co/datasets/hausa_voa_topics) | 84.76 | 90.98 
+
+### BibTeX entry and citation info
+By David Adelani
+```
+
+```
+
+

config.json

@@ -0,0 +1,30 @@
+{
+  "_name_or_path": "bert-base-multilingual-cased",
+  "architectures": [
+    "BertForMaskedLM"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "directionality": "bidi",
+  "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-12,
+  "max_position_embeddings": 512,
+  "model_type": "bert",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 0,
+  "pooler_fc_size": 768,
+  "pooler_num_attention_heads": 12,
+  "pooler_num_fc_layers": 3,
+  "pooler_size_per_head": 128,
+  "pooler_type": "first_token_transform",
+  "position_embedding_type": "absolute",
+  "transformers_version": "4.4.2",
+  "type_vocab_size": 2,
+  "use_cache": true,
+  "vocab_size": 119547
+}

pytorch_model.bin

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

special_tokens_map.json

@@ -0,0 +1 @@
+{"unk_token": "[UNK]", "sep_token": "[SEP]", "pad_token": "[PAD]", "cls_token": "[CLS]", "mask_token": "[MASK]"}

tokenizer_config.json

@@ -0,0 +1 @@
+{"do_lower_case": false, "unk_token": "[UNK]", "sep_token": "[SEP]", "pad_token": "[PAD]", "cls_token": "[CLS]", "mask_token": "[MASK]", "tokenize_chinese_chars": true, "strip_accents": null, "model_max_length": 512, "special_tokens_map_file": null, "name_or_path": "bert-base-multilingual-cased"}

training_args.bin

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