add model

README.md

@@ -0,0 +1,76 @@
+---
+language: en
+datasets:
+- librispeech_asr
+- common_voice
+tags:
+- speech
+license: apache-2.0
+---
+
+# M-CTC-T 
+​
+Massively multilingual speech recognizer from Meta AI. The model is a 1B-param transformer encoder, with a CTC head over 8065 character labels and a language identification head over 60 language ID labels. It is trained on Common Voice (version 6.1, December 2020 release) and VoxPopuli. After training on Common Voice and VoxPopuli, the model is trained on Common Voice only. The labels are unnormalized character-level transcripts (punctuation and capitalization are not removed). The model takes as input Mel filterbank features from a 16Khz audio signal.
+​
+![model image](https://raw.githubusercontent.com/cwkeam/scientific-images/main/MCTCT/mctct-arch.png) 
+​
+The original Flashlight code, model checkpoints, and Colab notebook can be found at https://github.com/flashlight/wav2letter/tree/main/recipes/mling_pl .
+​
+​
+## Citation
+​
+[Paper](https://arxiv.org/abs/2111.00161)
+​
+Authors: Loren Lugosch, Tatiana Likhomanenko, Gabriel Synnaeve, Ronan Collobert
+​
+```
+@article{lugosch2021pseudo,
+  title={Pseudo-Labeling for Massively Multilingual Speech Recognition},
+  author={Lugosch, Loren and Likhomanenko, Tatiana and Synnaeve, Gabriel and Collobert, Ronan},
+  journal={ICASSP},
+  year={2022}
+}
+```
+​
+Additional thanks to [Chan Woo Kim](https://huggingface.co/cwkeam) and [Patrick von Platen](https://huggingface.co/patrickvonplaten) for porting the model from Flashlight to PyTorch.
+​
+# Training method
+​
+![model image](https://raw.githubusercontent.com/cwkeam/scientific-images/main/MCTCT/mctct-slimipl.png) TO-DO: replace with the training diagram from paper
+​
+For more information on how the model was trained, please take a look at the [official paper](https://arxiv.org/abs/2111.00161).
+​
+# Usage
+​
+To transcribe audio files the model can be used as a standalone acoustic model as follows:
+​
+```python
+import torch
+import torchaudio
+from datasets import load_dataset
+from transformers import MCTCTForCTC, MCTCTProcessor
+
+model = MCTCTForCTC.from_pretrained("speechbrain/mctct-large")
+processor = MCTCTProcessor.from_pretrained("speechbrain/mctct-large")
+
+ # load dummy dataset and read soundfiles
+ds = load_dataset("patrickvonplaten/librispeech_asr_dummy", "clean", split="validation")
+ 
+# tokenize
+input_features = processor(ds[0]["audio"]["array"], return_tensors="pt").input_features 
+
+# retrieve logits
+logits = model(input_features).logits
+
+# take argmax and decode
+predicted_ids = torch.argmax(logits, dim=-1)
+transcription = processor.batch_decode(predicted_ids)
+```
+ 
+Results for Common Voice, averaged over all languages:
+​
+*Character error rate (CER)*:
+​
+| Valid | Test |
+|-------|------|
+| 21.4  | 23.3 |

added_tokens.json

@@ -0,0 +1 @@
+{"<s>": 8065, "</s>": 8066}

config.json

@@ -0,0 +1,40 @@
+{
+  "architectures": [
+    "MCTCTForCTC"
+  ],
+  "attention_head_dim": 384,
+  "attention_probs_dropout_prob": 0.3,
+  "bos_token_id": 0,
+  "conv_channels": null,
+  "conv_dropout": 0.3,
+  "conv_glu_dim": 1,
+  "conv_kernel": [
+    7
+  ],
+  "conv_stride": [
+    3
+  ],
+  "ctc_loss_reduction": "sum",
+  "ctc_zero_infinity": false,
+  "eos_token_id": 2,
+  "hidden_act": "relu",
+  "hidden_dropout_prob": 0.3,
+  "hidden_size": 1536,
+  "initializer_range": 0.02,
+  "input_channels": 1,
+  "input_feat_per_channel": 80,
+  "intermediate_size": 6144,
+  "layer_norm_eps": 1e-05,
+  "layerdrop": 0.3,
+  "max_position_embeddings": 920,
+  "model_type": "mctct",
+  "num_attention_heads": 4,
+  "num_conv_layers": 1,
+  "num_hidden_layers": 36,
+  "pad_token_id": 1,
+  "position_embedding_type": "relative_key",
+  "torch_dtype": "float32",
+  "transformers_version": "4.18.0.dev0",
+  "use_cache": true,
+  "vocab_size": 8065
+}

preprocessor_config.json

@@ -0,0 +1,21 @@
+{
+  "K": 257,
+  "do_normalize": true,
+  "feature_extractor_type": "MCTCFeatureExtractor",
+  "feature_size": 80,
+  "frame_signal_scale": 32768.0,
+  "hop_length": 10,
+  "mel_floor": 1.0,
+  "n_fft": 512,
+  "normalize_means": true,
+  "normalize_vars": true,
+  "padding_side": "right",
+  "padding_value": 0.0,
+  "preemphasis_coeff": 0.97,
+  "return_attention_mask": false,
+  "sample_size": 400,
+  "sample_stride": 160,
+  "sampling_rate": 16000,
+  "win_function": "hamming_window",
+  "win_length": 25
+}

pytorch_model.bin

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

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": "|", "replace_word_delimiter_char": " ", "return_attention_mask": false, "do_normalize": true, "special_tokens_map_file": "./mctc-large/special_tokens_map.json", "name_or_path": "./mctc-large", "tokenizer_class": "Wav2Vec2CTCTokenizer"}