Kinyarwanda Model

.gitattributes

@@ -2,27 +2,20 @@
 *.arrow filter=lfs diff=lfs merge=lfs -text
 *.bin filter=lfs diff=lfs merge=lfs -text
 *.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
 *.ftz filter=lfs diff=lfs merge=lfs -text
 *.gz filter=lfs diff=lfs merge=lfs -text
 *.h5 filter=lfs diff=lfs merge=lfs -text
 *.joblib filter=lfs diff=lfs merge=lfs -text
 *.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
 *.model filter=lfs diff=lfs merge=lfs -text
 *.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
 *.onnx filter=lfs diff=lfs merge=lfs -text
 *.ot filter=lfs diff=lfs merge=lfs -text
 *.parquet filter=lfs diff=lfs merge=lfs -text
 *.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
 *.pt filter=lfs diff=lfs merge=lfs -text
 *.pth filter=lfs diff=lfs merge=lfs -text
 *.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
 saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.tar.* filter=lfs diff=lfs merge=lfs -text
 *.tflite filter=lfs diff=lfs merge=lfs -text
@@ -30,6 +23,7 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.wasm filter=lfs diff=lfs merge=lfs -text
 *.xz filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
+*.zstandard filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
-Kinyarwanda_nemo_stt_conformer_model.nemo filter=lfs diff=lfs merge=lfs -text
+6gram.bin filter=lfs diff=lfs merge=lfs -text
+unigrams.txt filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1 @@
+checkpoint-*/

Kinyarwanda_model.nemo → 6gram.bin

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:b96caae115055a37013539d5cc109f40b8994b8e323368b1116e543c9d7c0708
-size 488570880
+oid sha256:aaecc5e62e869411a2c9e7bbb912a231168d37e014752d21f70713a4b58d1e7f
+size 26999898

README.md

@@ -1,104 +1,128 @@
 ---
-language:
-- rw
-license: cc-by-4.0
-library_name: nemo
-datasets:
-- mozilla-foundation/common_voice_11_0
-thumbnail: null
+license: apache-2.0
 tags:
-- automatic-speech-recognition
-- speech
-- audio
-- CTC
-- Conformer
-- Transformer
-- NeMo
-- pytorch
+- generated_from_trainer
+datasets:
+- common_voice
 model-index:
-- name: Kinyarwanda_nemo_stt_conformer_model
+- name: wav2vec2-large-xls-r-300m-kinyarwanda
   results: []
-
 ---
-## Model Source
-
-Forked from https://huggingface.co/mbazaNLP/Kinyarwanda_nemo_stt_conformer_model
-
-## Model Overview
-
-<DESCRIBE IN ONE LINE THE MODEL AND ITS USE>
-
-## NVIDIA NeMo: Training
-
-To train, fine-tune or play with the model you will need to install [NVIDIA NeMo](https://github.com/NVIDIA/NeMo). We recommend you install it after you've installed latest Pytorch version.
-```
-pip install nemo_toolkit['all']
-``` 
-
-## How to Use this Model
-
-The model is available for use in the NeMo toolkit [3], and can be used as a pre-trained checkpoint for inference or for fine-tuning on another dataset.
-
-### Automatically instantiate the model
-
-```python
-import nemo.collections.asr as nemo_asr
-asr_model = nemo_asr.models.ASRModel.from_pretrained("mbazaNLP/Kinyarwanda_nemo_stt_conformer_model")
-```
-
-### Transcribing using Python
-First, let's get a sample
-```
-wget https://dldata-public.s3.us-east-2.amazonaws.com/2086-149220-0033.wav
-```
-Then simply do:
-```
-asr_model.transcribe(['2086-149220-0033.wav'])
-```
-
-### Transcribing many audio files
-
-```shell
-python [NEMO_GIT_FOLDER]/examples/asr/transcribe_speech.py  pretrained_name="mbazaNLP/Kinyarwanda_nemo_stt_conformer_model"  audio_dir="<DIRECTORY CONTAINING AUDIO FILES>"
-```
-
-### Input
-
-This model accepts 16000 KHz Mono-channel Audio (wav files) as input.
-
-### Output
-
-This model provides transcribed speech as a string for a given audio sample.
-
-## Model Architecture
-
-<ADD SOME INFORMATION ABOUT THE ARCHITECTURE>
-
-## Training
-
-<ADD INFORMATION ABOUT HOW THE MODEL WAS TRAINED - HOW MANY EPOCHS, AMOUNT OF COMPUTE ETC>
-
-### Datasets
-
-<LIST THE NAME AND SPLITS OF DATASETS USED TO TRAIN THIS MODEL (ALONG WITH LANGUAGE AND ANY ADDITIONAL INFORMATION)>
-
-## Performance
-
-<LIST THE SCORES OF THE MODEL - 
-      OR
-USE THE Hugging Face Evaluate LiBRARY TO UPLOAD METRICS>
-
-## Limitations
-
-<DECLARE ANY POTENTIAL LIMITATIONS OF THE MODEL>
-
-Eg: 
-Since this model was trained on publically available speech datasets, the performance of this model might degrade for speech which includes technical terms, or vernacular that the model has not been trained on. The model might also perform worse for accented speech.
-
-
-## References
-
-<ADD ANY REFERENCES HERE AS NEEDED>
-
-[1] [NVIDIA NeMo Toolkit](https://github.com/NVIDIA/NeMo)
 
+<!-- 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. -->
+
+# wav2vec2-large-xls-r-300m-kinyarwanda
+
+This model is a fine-tuned version of [facebook/wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m) on the common_voice dataset.
+It achieves the following results on the evaluation set:
+- Loss: 0.3917
+- Wer: 0.3246
+
+## 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: 7e-05
+- train_batch_size: 12
+- eval_batch_size: 8
+- seed: 42
+- gradient_accumulation_steps: 2
+- total_train_batch_size: 24
+- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- lr_scheduler_type: linear
+- lr_scheduler_warmup_steps: 400
+- num_epochs: 8
+- mixed_precision_training: Native AMP
+
+### Training results
+
+| Training Loss | Epoch | Step  | Validation Loss | Wer    |
+|:-------------:|:-----:|:-----:|:---------------:|:------:|
+| 9.0634        | 0.12  | 400   | 3.0554          | 1.0    |
+| 2.8009        | 0.24  | 800   | 1.5927          | 0.9554 |
+| 0.9022        | 0.36  | 1200  | 0.7328          | 0.6445 |
+| 0.6213        | 0.48  | 1600  | 0.6138          | 0.5510 |
+| 0.5299        | 0.6   | 2000  | 0.6072          | 0.5223 |
+| 0.4999        | 0.72  | 2400  | 0.5449          | 0.4969 |
+| 0.4731        | 0.84  | 2800  | 0.5261          | 0.4828 |
+| 0.458         | 0.96  | 3200  | 0.5058          | 0.4607 |
+| 0.4158        | 1.09  | 3600  | 0.4892          | 0.4463 |
+| 0.4037        | 1.21  | 4000  | 0.4759          | 0.4429 |
+| 0.4021        | 1.33  | 4400  | 0.4615          | 0.4330 |
+| 0.3934        | 1.45  | 4800  | 0.4593          | 0.4315 |
+| 0.3808        | 1.57  | 5200  | 0.4736          | 0.4344 |
+| 0.3838        | 1.69  | 5600  | 0.4569          | 0.4249 |
+| 0.3726        | 1.81  | 6000  | 0.4473          | 0.4140 |
+| 0.3623        | 1.93  | 6400  | 0.4403          | 0.4097 |
+| 0.3517        | 2.05  | 6800  | 0.4389          | 0.4061 |
+| 0.333         | 2.17  | 7200  | 0.4383          | 0.4104 |
+| 0.3354        | 2.29  | 7600  | 0.4360          | 0.3955 |
+| 0.3257        | 2.41  | 8000  | 0.4226          | 0.3942 |
+| 0.3275        | 2.53  | 8400  | 0.4206          | 0.4040 |
+| 0.3262        | 2.65  | 8800  | 0.4172          | 0.3875 |
+| 0.3206        | 2.77  | 9200  | 0.4209          | 0.3877 |
+| 0.323         | 2.89  | 9600  | 0.4177          | 0.3825 |
+| 0.3099        | 3.01  | 10000 | 0.4101          | 0.3691 |
+| 0.3008        | 3.14  | 10400 | 0.4055          | 0.3709 |
+| 0.2918        | 3.26  | 10800 | 0.4085          | 0.3800 |
+| 0.292         | 3.38  | 11200 | 0.4089          | 0.3713 |
+| 0.292         | 3.5   | 11600 | 0.4092          | 0.3730 |
+| 0.2785        | 3.62  | 12000 | 0.4151          | 0.3687 |
+| 0.2941        | 3.74  | 12400 | 0.4004          | 0.3639 |
+| 0.2838        | 3.86  | 12800 | 0.4108          | 0.3703 |
+| 0.2854        | 3.98  | 13200 | 0.3911          | 0.3596 |
+| 0.2683        | 4.1   | 13600 | 0.3944          | 0.3575 |
+| 0.2647        | 4.22  | 14000 | 0.3836          | 0.3538 |
+| 0.2704        | 4.34  | 14400 | 0.4006          | 0.3540 |
+| 0.2664        | 4.46  | 14800 | 0.3974          | 0.3553 |
+| 0.2662        | 4.58  | 15200 | 0.3890          | 0.3470 |
+| 0.2615        | 4.7   | 15600 | 0.3856          | 0.3507 |
+| 0.2553        | 4.82  | 16000 | 0.3814          | 0.3497 |
+| 0.2587        | 4.94  | 16400 | 0.3837          | 0.3440 |
+| 0.2522        | 5.06  | 16800 | 0.3834          | 0.3486 |
+| 0.2451        | 5.19  | 17200 | 0.3897          | 0.3414 |
+| 0.2423        | 5.31  | 17600 | 0.3864          | 0.3481 |
+| 0.2434        | 5.43  | 18000 | 0.3808          | 0.3416 |
+| 0.2525        | 5.55  | 18400 | 0.3795          | 0.3408 |
+| 0.2427        | 5.67  | 18800 | 0.3841          | 0.3411 |
+| 0.2411        | 5.79  | 19200 | 0.3804          | 0.3366 |
+| 0.2404        | 5.91  | 19600 | 0.3800          | 0.3328 |
+| 0.2372        | 6.03  | 20000 | 0.3749          | 0.3335 |
+| 0.2244        | 6.15  | 20400 | 0.3820          | 0.3327 |
+| 0.2381        | 6.27  | 20800 | 0.3789          | 0.3325 |
+| 0.2294        | 6.39  | 21200 | 0.3867          | 0.3298 |
+| 0.2378        | 6.51  | 21600 | 0.3843          | 0.3281 |
+| 0.2312        | 6.63  | 22000 | 0.3813          | 0.3277 |
+| 0.2411        | 6.75  | 22400 | 0.3780          | 0.3268 |
+| 0.2315        | 6.87  | 22800 | 0.3790          | 0.3280 |
+| 0.241         | 6.99  | 23200 | 0.3776          | 0.3281 |
+| 0.2313        | 7.11  | 23600 | 0.3929          | 0.3283 |
+| 0.2423        | 7.24  | 24000 | 0.3905          | 0.3280 |
+| 0.2337        | 7.36  | 24400 | 0.3979          | 0.3249 |
+| 0.2368        | 7.48  | 24800 | 0.3980          | 0.3257 |
+| 0.2409        | 7.6   | 25200 | 0.3937          | 0.3229 |
+| 0.2416        | 7.72  | 25600 | 0.3867          | 0.3237 |
+| 0.2364        | 7.84  | 26000 | 0.3912          | 0.3253 |
+| 0.234         | 7.96  | 26400 | 0.3917          | 0.3246 |
+
+
+### Framework versions
+
+- Transformers 4.11.3
+- Pytorch 1.10.0+cu113
+- Datasets 1.18.3
+- Tokenizers 0.10.3

added_tokens.json

@@ -0,0 +1 @@
+{"<s>": 97, "</s>": 98}

config.json

@@ -0,0 +1,79 @@
+{
+  "_name_or_path": "facebook/wav2vec2-xls-r-300m",
+  "activation_dropout": 0.0,
+  "apply_spec_augment": true,
+  "architectures": [
+    "Wav2Vec2ForCTC"
+  ],
+  "attention_dropout": 0.05,
+  "bos_token_id": 1,
+  "classifier_proj_size": 256,
+  "codevector_dim": 768,
+  "contrastive_logits_temperature": 0.1,
+  "conv_bias": true,
+  "conv_dim": [
+    512,
+    512,
+    512,
+    512,
+    512,
+    512,
+    512
+  ],
+  "conv_kernel": [
+    10,
+    3,
+    3,
+    3,
+    3,
+    2,
+    2
+  ],
+  "conv_stride": [
+    5,
+    2,
+    2,
+    2,
+    2,
+    2,
+    2
+  ],
+  "ctc_loss_reduction": "mean",
+  "ctc_zero_infinity": false,
+  "diversity_loss_weight": 0.1,
+  "do_stable_layer_norm": true,
+  "eos_token_id": 2,
+  "feat_extract_activation": "gelu",
+  "feat_extract_dropout": 0.0,
+  "feat_extract_norm": "layer",
+  "feat_proj_dropout": 0.05,
+  "feat_quantizer_dropout": 0.0,
+  "final_dropout": 0.0,
+  "gradient_checkpointing": false,
+  "hidden_act": "gelu",
+  "hidden_dropout": 0.05,
+  "hidden_size": 1024,
+  "initializer_range": 0.02,
+  "intermediate_size": 4096,
+  "layer_norm_eps": 1e-05,
+  "layerdrop": 0.05,
+  "mask_feature_length": 10,
+  "mask_feature_prob": 0.0,
+  "mask_time_length": 10,
+  "mask_time_prob": 0.05,
+  "model_type": "wav2vec2",
+  "num_attention_heads": 16,
+  "num_codevector_groups": 2,
+  "num_codevectors_per_group": 320,
+  "num_conv_pos_embedding_groups": 16,
+  "num_conv_pos_embeddings": 128,
+  "num_feat_extract_layers": 7,
+  "num_hidden_layers": 24,
+  "num_negatives": 100,
+  "pad_token_id": 96,
+  "proj_codevector_dim": 768,
+  "torch_dtype": "float32",
+  "transformers_version": "4.11.3",
+  "use_weighted_layer_sum": false,
+  "vocab_size": 99
+}

preprocessor_config.json

@@ -0,0 +1,9 @@
+{
+  "do_normalize": true,
+  "feature_extractor_type": "Wav2Vec2FeatureExtractor",
+  "feature_size": 1,
+  "padding_side": "right",
+  "padding_value": 0.0,
+  "return_attention_mask": true,
+  "sampling_rate": 16000
+}

pytorch_model.bin

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

readme_template.md

@@ -1,102 +0,0 @@
----
-language:
-- rw
-license: cc-by-4.0
-library_name: nemo
-datasets:
-- mozilla-foundation/common_voice_11_0
-thumbnail: null
-tags:
-- automatic-speech-recognition
-- speech
-- audio
-- CTC
-- Conformer
-- Transformer
-- NeMo
-- pytorch
-model-index:
-- name: Kinyarwanda_nemo_stt_conformer_model
-  results: []
-
----
-
-
-## Model Overview
-
-<DESCRIBE IN ONE LINE THE MODEL AND ITS USE>
-
-## NVIDIA NeMo: Training
-
-To train, fine-tune or play with the model you will need to install [NVIDIA NeMo](https://github.com/NVIDIA/NeMo). We recommend you install it after you've installed latest Pytorch version.
-```
-pip install nemo_toolkit['all']
-``` 
-
-## How to Use this Model
-
-The model is available for use in the NeMo toolkit [3], and can be used as a pre-trained checkpoint for inference or for fine-tuning on another dataset.
-
-### Automatically instantiate the model
-
-```python
-import nemo.collections.asr as nemo_asr
-asr_model = nemo_asr.models.ASRModel.from_pretrained("mbazaNLP/Kinyarwanda_nemo_stt_conformer_model")
-```
-
-### Transcribing using Python
-First, let's get a sample
-```
-wget https://dldata-public.s3.us-east-2.amazonaws.com/2086-149220-0033.wav
-```
-Then simply do:
-```
-asr_model.transcribe(['2086-149220-0033.wav'])
-```
-
-### Transcribing many audio files
-
-```shell
-python [NEMO_GIT_FOLDER]/examples/asr/transcribe_speech.py  pretrained_name="mbazaNLP/Kinyarwanda_nemo_stt_conformer_model"  audio_dir="<DIRECTORY CONTAINING AUDIO FILES>"
-```
-
-### Input
-
-This model accepts 16000 KHz Mono-channel Audio (wav files) as input.
-
-### Output
-
-This model provides transcribed speech as a string for a given audio sample.
-
-## Model Architecture
-
-<ADD SOME INFORMATION ABOUT THE ARCHITECTURE>
-
-## Training
-
-<ADD INFORMATION ABOUT HOW THE MODEL WAS TRAINED - HOW MANY EPOCHS, AMOUNT OF COMPUTE ETC>
-
-### Datasets
-
-<LIST THE NAME AND SPLITS OF DATASETS USED TO TRAIN THIS MODEL (ALONG WITH LANGUAGE AND ANY ADDITIONAL INFORMATION)>
-
-## Performance
-
-<LIST THE SCORES OF THE MODEL - 
-      OR
-USE THE Hugging Face Evaluate LiBRARY TO UPLOAD METRICS>
-
-## Limitations
-
-<DECLARE ANY POTENTIAL LIMITATIONS OF THE MODEL>
-
-Eg: 
-Since this model was trained on publically available speech datasets, the performance of this model might degrade for speech which includes technical terms, or vernacular that the model has not been trained on. The model might also perform worse for accented speech.
-
-
-## References
-
-<ADD ANY REFERENCES HERE AS NEEDED>
-
-[1] [NVIDIA NeMo Toolkit](https://github.com/NVIDIA/NeMo)
-

runs/Jun01_14-34-06_39fa4a121b79/1654096407.335164/events.out.tfevents.1654096407.39fa4a121b79.97.1

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

runs/Jun01_14-34-06_39fa4a121b79/events.out.tfevents.1654096407.39fa4a121b79.97.0

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

runs/Jun02_19-30-03_e97f4e46d604/1654200508.2227576/events.out.tfevents.1654200508.e97f4e46d604.97.1

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

runs/Jun02_19-30-03_e97f4e46d604/events.out.tfevents.1654200508.e97f4e46d604.97.0

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

special_tokens_map.json

@@ -0,0 +1 @@
+{"bos_token": "<s>", "eos_token": "</s>", "unk_token": "[UNK]", "pad_token": "[PAD]", "additional_special_tokens": [{"content": "<s>", "single_word": false, "lstrip": false, "rstrip": false, "normalized": true}, {"content": "</s>", "single_word": false, "lstrip": false, "rstrip": false, "normalized": true}]}

tokenizer_config.json

@@ -0,0 +1 @@
+{"unk_token": "[UNK]", "bos_token": "<s>", "eos_token": "</s>", "pad_token": "[PAD]", "do_lower_case": false, "word_delimiter_token": "|", "special_tokens_map_file": null, "tokenizer_file": null, "name_or_path": "./", "tokenizer_class": "Wav2Vec2CTCTokenizer"}

training_args.bin

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

unigrams.txt

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

vocab.json

@@ -0,0 +1 @@
+{"#": 1, "(": 2, ")": 3, "*": 4, "+": 5, "<": 6, "=": 7, ">": 8, "@": 9, "\\": 10, "_": 11, "`": 12, "a": 13, "b": 14, "c": 15, "d": 16, "e": 17, "f": 18, "g": 19, "h": 20, "i": 21, "j": 22, "k": 23, "l": 24, "m": 25, "n": 26, "o": 27, "p": 28, "q": 29, "r": 30, "s": 31, "t": 32, "u": 33, "v": 34, "w": 35, "x": 36, "y": 37, "z": 38, "£": 39, "¨": 40, "©": 41, "«": 42, "®": 43, "°": 44, "»": 45, "¼": 46, "½": 47, "á": 48, "é": 49, "ï": 50, "ñ": 51, "ò": 52, "ö": 53, "ø": 54, "ù": 55, "ü": 56, "ÿ": 57, "ā": 58, "ć": 59, "ē": 60, "ğ": 61, "ī": 62, "ō": 63, "œ": 64, "ş": 65, "š": 66, "ū": 67, "ȃ": 68, "ȏ": 69, "ʺ": 70, "ʼ": 71, "ʽ": 72, "˜": 73, "˝": 74, "̀": 75, "в": 76, "к": 77, "о": 78, "у": 79, "і": 80, "ḥ": 81, "ṭ": 82, "‐": 83, "–": 84, "—": 85, "―": 86, "’": 87, "‟": 88, "•": 89, "…": 90, "″": 91, "‽": 92, "€": 93, "™": 94, "|": 0, "[UNK]": 95, "[PAD]": 96}