feat: add best model iteration from second run and language models

.gitattributes

@@ -30,3 +30,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+*.arpa filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,66 @@
 ---
+language: 
+- bn
+language_bcp47:
+- bn-BD
+tags:
+- automatic-speech-recognition
+- bn
+- common_voice_9_0
+- openslr_SLR53
+datasets:
+- common_voice_bn
+- openSLR53
+- multilingual_librispeech
+metrics:
+- wer
+- cer
+model-index:
+- name: shahruk10/wav2vec2-xls-r-300m-bengali-commonvoice
+  results:
+  - task:
+      type: automatic-speech-recognition
+      name: Speech Recognition
+    dataset:
+      type: common_voice_9_0
+      name: Common Voice (Bengali)
+      args: common_voice_bn
+    metrics:
+    - type: wer
+      value: 0.01793038418929547
+      name: Validation WER with 5-gram LM
+    - type: cer
+      value: 0.08078964599673999
+      name: Validation CER with 5-gram LM
 license: apache-2.0
 ---
+
+# Wav2Vec2-XLS-R-300M-Bengali-CommonVoice
+
+- This model is a fine-tuned version of [arijitx/wav2vec2-xls-r-300m-bengali](https://huggingface.co/arijitx/wav2vec2-xls-r-300m-bengali) on the the Common Voice 9.0 Bengali dataset. In total, the model was trained on ~300 hours of Bengali (Bangladesh accent) 16 kHz audio data.
+
+- The training and and validation partitions used were provided by the organizers of the [BUET CSE Fest 2022 DL Sprint Competition on Kaggle](https://www.kaggle.com/competitions/dlsprint).
+
+- The model placed first on both the public and private leader boards.
+
+- A 5-gram language model generated from the training split was used with model.
+
+## Metrics
+
+- The model was evaluated using Word Error Rate (WER) and Character Error Rate (CER) for the validation set. At the time, the test set labels were not made available by the organizers of the Kaggle competition which provided the data splits for training.
+ 
+
+|  Model  | Split |  CER  |  WER |
+|:-------:|:-----:|:-----:|:------:|
+| With 5-gram LM | Validation | 0.08079 | 0.017939 |
+
+
+## Training
+
+- The training notebook for this model can be found on Kaggle [here](https://www.kaggle.com/code/shahruk10/training-notebook-wav2vec2).
+
+- The inference notebook for this model can be found on Kaggle [here](https://www.kaggle.com/code/shahruk10/inference-notebook-wav2vec2).
+
+- The model was first trained for 15 epochs on the training split (with on-the-fly augmentation). Dropouts were enabled and a cosine decay learning rate schedule starting from 3e-5 was used.
+
+- The best iteration from the first run was further fine-tuned for 5 epochs at constant learning rate of 1e-7 with dropouts disabled.

alphabet.json

@@ -0,0 +1 @@
+{"labels": [" ", "_", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "r", "s", "t", "u", "v", "w", "x", "y", "z", "\u0093", "\u0094", "\u0153", "\u0964", "\u0981", "\u0982", "\u0983", "\u0985", "\u0986", "\u0987", "\u0988", "\u0989", "\u098a", "\u098b", "\u098f", "\u0990", "\u0993", "\u0994", "\u0995", "\u0996", "\u0997", "\u0998", "\u0999", "\u099a", "\u099b", "\u099c", "\u099d", "\u099e", "\u099f", "\u09a0", "\u09a1", "\u09a2", "\u09a3", "\u09a4", "\u09a5", "\u09a6", "\u09a7", "\u09a8", "\u09aa", "\u09ab", "\u09ac", "\u09ad", "\u09ae", "\u09af", "\u09b0", "\u09b2", "\u09b6", "\u09b7", "\u09b8", "\u09b9", "\u09bc", "\u09be", "\u09bf", "\u09c0", "\u09c1", "\u09c2", "\u09c3", "\u09c7", "\u09c8", "\u09cb", "\u09cc", "\u09cd", "\u09ce", "\u09d7", "\u09dc", "\u09dd", "\u09df", "\u09e6", "\u09e7", "\u09e8", "\u09e9", "\u09ea", "\u09eb", "\u09ec", "\u09ed", "\u09ee", "\u09ef", "\u09f0", "\u200c", "\u200d", "\u200e", "\u2047", "", "<s>", "</s>"], "is_bpe": false}

config.json

@@ -0,0 +1,106 @@
+{
+  "activation_dropout": 0.1,
+  "adapter_kernel_size": 3,
+  "adapter_stride": 2,
+  "add_adapter": false,
+  "apply_spec_augment": true,
+  "architectures": [
+    "Wav2Vec2ForCTC"
+  ],
+  "attention_dropout": 0,
+  "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,
+  "feat_quantizer_dropout": 0.0,
+  "final_dropout": 0.0,
+  "hidden_act": "gelu",
+  "hidden_dropout": 0,
+  "hidden_size": 1024,
+  "initializer_range": 0.02,
+  "intermediate_size": 4096,
+  "layer_norm_eps": 1e-05,
+  "layerdrop": 0,
+  "mask_feature_length": 64,
+  "mask_feature_min_masks": 0,
+  "mask_feature_prob": 0.25,
+  "mask_time_length": 10,
+  "mask_time_min_masks": 2,
+  "mask_time_prob": 0,
+  "model_type": "wav2vec2",
+  "num_adapter_layers": 3,
+  "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,
+  "output_hidden_size": 1024,
+  "pad_token_id": 109,
+  "proj_codevector_dim": 768,
+  "tdnn_dilation": [
+    1,
+    2,
+    3,
+    1,
+    1
+  ],
+  "tdnn_dim": [
+    512,
+    512,
+    512,
+    512,
+    1500
+  ],
+  "tdnn_kernel": [
+    5,
+    3,
+    3,
+    1,
+    1
+  ],
+  "torch_dtype": "float32",
+  "transformers_version": "4.20.1",
+  "use_weighted_layer_sum": false,
+  "vocab_size": 112,
+  "xvector_output_dim": 512
+}

language_model/attrs.json

@@ -0,0 +1 @@
+{"alpha": 0.6, "beta": 0.25, "unk_score_offset": -10.0, "score_boundary": true}

language_model/commonvoice-bn.5.arpa

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

preprocessor_config.json

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

pytorch_model.bin

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

special_tokens_map.json

@@ -0,0 +1,6 @@
+{
+  "bos_token": "<s>",
+  "eos_token": "</s>",
+  "pad_token": "[PAD]",
+  "unk_token": "[UNK]"
+}

tokenizer_config.json

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

vocab.json

@@ -0,0 +1,114 @@
+{
+  "</s>": 111,
+  "<s>": 110,
+  "[PAD]": 109,
+  "[UNK]": 108,
+  "_": 1,
+  "a": 2,
+  "b": 3,
+  "c": 4,
+  "d": 5,
+  "e": 6,
+  "f": 7,
+  "g": 8,
+  "h": 9,
+  "i": 10,
+  "j": 11,
+  "k": 12,
+  "l": 13,
+  "m": 14,
+  "n": 15,
+  "o": 16,
+  "p": 17,
+  "r": 18,
+  "s": 19,
+  "t": 20,
+  "u": 21,
+  "v": 22,
+  "w": 23,
+  "x": 24,
+  "y": 25,
+  "z": 26,
+  "|": 0,
+  "“": 27,
+  "”": 28,
+  "œ": 29,
+  "।": 30,
+  "ঁ": 31,
+  "ং": 32,
+  "ঃ": 33,
+  "অ": 34,
+  "আ": 35,
+  "ই": 36,
+  "ঈ": 37,
+  "উ": 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,
+  "১": 95,
+  "২": 96,
+  "৩": 97,
+  "৪": 98,
+  "৫": 99,
+  "৬": 100,
+  "৭": 101,
+  "৮": 102,
+  "৯": 103,
+  "ৰ": 104,
+  "‌": 105,
+  "‍": 106,
+  "‎": 107
+}