Pushing models

README.md

@@ -0,0 +1,77 @@
+---
+language: "it"
+thumbnail:
+tags:
+- ASR
+- CTC
+- Attention
+- pytorch
+license: "apache-2.0"
+datasets:
+- commonvoice
+metrics:
+- wer
+- cer
+---
+
+# CRDNN with CTC/Attention trained on CommonVoice Italian (No LM)
+
+This repository provides all the necessary tools to perform automatic speech
+recognition from an end-to-end system pretrained on CommonVoice (IT) within
+SpeechBrain. For a better experience we encourage you to learn more about
+[SpeechBrain](https://speechbrain.github.io). The given ASR model performance are:
+
+| Release | Test CER | Test WER | GPUs |
+|:-------------:|:--------------:|:--------------:| :--------:|
+| 07-03-21 | 5.40 | 16.61 | 2xV100 16GB |
+
+## Pipeline description
+
+This ASR system is composed with 2 different but linked blocks:
+1. Tokenizer (unigram) that transforms words into subword units and trained with
+the train transcriptions (train.tsv) of CommonVoice (IT).
+3. Acoustic model (CRDNN + CTC/Attention). The CRDNN architecture is made of
+N blocks of convolutional neural networks with normalisation and pooling on the
+frequency domain. Then, a bidirectional LSTM is connected to a final DNN to obtain
+the final acoustic representation that is given to the CTC and attention decoders.
+
+## Intended uses & limitations
+
+This model has been primilarly developed to be run within SpeechBrain as a pretrained ASR model
+for the Italian language. Thanks to the flexibility of SpeechBrain, any of the 2 blocks
+detailed above can be extracted and connected to you custom pipeline as long as SpeechBrain is
+installed.
+
+## Install SpeechBrain
+
+First of all, please install SpeechBrain with the following command:
+
+```
+pip install \\we hide ! SpeechBrain is still private :p
+```
+
+Please notice that we encourage you to read our tutorials and learn more about
+[SpeechBrain](https://speechbrain.github.io).
+
+### Transcribing your own audio files
+
+```python
+from speechbrain.pretrained import EncoderDecoderASR
+
+asr_model = EncoderDecoderASR.from_hparams(source="speechbrain/asr-crdnn-commonvoice-it")
+asr_model.transcribe_file("path_to_your_file.wav")
+
+```
+
+#### Referencing SpeechBrain
+
+```
+@misc{SB2021,
+    author = {Ravanelli, Mirco and Parcollet, Titouan and Rouhe, Aku and Plantinga, Peter and Rastorgueva, Elena and Lugosch, Loren and Dawalatabad, Nauman and Ju-Chieh, Chou and Heba, Abdel and Grondin, Francois and Aris, William and Liao, Chien-Feng and Cornell, Samuele and Yeh, Sung-Lin and Na, Hwidong and Gao, Yan and Fu, Szu-Wei and Subakan, Cem and De Mori, Renato and Bengio, Yoshua },
+    title = {SpeechBrain},
+    year = {2021},
+    publisher = {GitHub},
+    journal = {GitHub repository},
+    howpublished = {\url{https://github.com/speechbrain/speechbrain}},
+  }
+```

asr.ckpt

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

hyperparams.yaml

@@ -0,0 +1,133 @@
+# ################################
+# Model: VGG2 + LSTM + time pooling
+# Augmentation: SpecAugment
+# Authors: Titouan Parcollet, Mirco Ravanelli, Peter Plantinga, Ju-Chieh Chou,
+# and Abdel HEBA 2020
+# ################################
+
+# Feature parameters (FBANKS etc)
+sample_rate: 16000
+n_fft: 400
+n_mels: 80
+
+# Model parameters
+activation: !name:torch.nn.LeakyReLU
+dropout: 0.15
+cnn_blocks: 3
+cnn_channels: (128, 200, 256)
+inter_layer_pooling_size: (2, 2, 2)
+cnn_kernelsize: (3, 3)
+time_pooling_size: 4
+rnn_class: !name:speechbrain.nnet.RNN.LSTM
+rnn_layers: 5
+rnn_neurons: 1024
+rnn_bidirectional: True
+dnn_blocks: 2
+dnn_neurons: 1024
+emb_size: 128
+dec_neurons: 1024
+
+# Outputs
+output_neurons: 500  # BPE size, index(blank/eos/bos) = 0
+
+# Decoding parameters
+# Be sure that the bos and eos index match with the BPEs ones
+blank_index: 0
+bos_index: 0
+eos_index: 0
+min_decode_ratio: 0.0
+max_decode_ratio: 1.0
+beam_size: 80
+eos_threshold: 1.5
+using_max_attn_shift: True
+max_attn_shift: 140
+ctc_weight_decode: 0.0
+temperature: 1.50
+
+normalize: !new:speechbrain.processing.features.InputNormalization
+    norm_type: global
+
+compute_features: !new:speechbrain.lobes.features.Fbank
+    sample_rate: !ref <sample_rate>
+    n_fft: !ref <n_fft>
+    n_mels: !ref <n_mels>
+
+enc: !new:speechbrain.lobes.models.CRDNN.CRDNN
+    input_shape: [null, null, !ref <n_mels>]
+    activation: !ref <activation>
+    dropout: !ref <dropout>
+    cnn_blocks: !ref <cnn_blocks>
+    cnn_channels: !ref <cnn_channels>
+    cnn_kernelsize: !ref <cnn_kernelsize>
+    inter_layer_pooling_size: !ref <inter_layer_pooling_size>
+    time_pooling: True
+    using_2d_pooling: False
+    time_pooling_size: !ref <time_pooling_size>
+    rnn_class: !ref <rnn_class>
+    rnn_layers: !ref <rnn_layers>
+    rnn_neurons: !ref <rnn_neurons>
+    rnn_bidirectional: !ref <rnn_bidirectional>
+    rnn_re_init: True
+    dnn_blocks: !ref <dnn_blocks>
+    dnn_neurons: !ref <dnn_neurons>
+
+emb: !new:speechbrain.nnet.embedding.Embedding
+    num_embeddings: !ref <output_neurons>
+    embedding_dim: !ref <emb_size>
+
+dec: !new:speechbrain.nnet.RNN.AttentionalRNNDecoder
+    enc_dim: !ref <dnn_neurons>
+    input_size: !ref <emb_size>
+    rnn_type: gru
+    attn_type: location
+    hidden_size: 1024
+    attn_dim: 1024
+    num_layers: 1
+    scaling: 1.0
+    channels: 10
+    kernel_size: 100
+    re_init: True
+    dropout: !ref <dropout>
+
+ctc_lin: !new:speechbrain.nnet.linear.Linear
+    input_size: !ref <dnn_neurons>
+    n_neurons: !ref <output_neurons>
+
+seq_lin: !new:speechbrain.nnet.linear.Linear
+    input_size: !ref <dec_neurons>
+    n_neurons: !ref <output_neurons>
+
+log_softmax: !new:speechbrain.nnet.activations.Softmax
+    apply_log: True
+
+asr_model: !new:torch.nn.ModuleList
+    - [!ref <enc>, !ref <emb>, !ref <dec>, !ref <ctc_lin>, !ref <seq_lin>]
+
+tokenizer: !new:sentencepiece.SentencePieceProcessor
+
+beam_searcher: !new:speechbrain.decoders.S2SRNNBeamSearcher
+    embedding: !ref <emb>
+    decoder: !ref <dec>
+    linear: !ref <seq_lin>
+    bos_index: !ref <bos_index>
+    eos_index: !ref <eos_index>
+    min_decode_ratio: !ref <min_decode_ratio>
+    max_decode_ratio: !ref <max_decode_ratio>
+    beam_size: !ref <beam_size>
+    eos_threshold: !ref <eos_threshold>
+    using_max_attn_shift: !ref <using_max_attn_shift>
+    max_attn_shift: !ref <max_attn_shift>
+    temperature: !ref <temperature>
+
+modules:
+    compute_features: !ref <compute_features>
+    normalize: !ref <normalize>
+    asr_model: !ref <asr_model>
+    asr_encoder: !ref <enc>
+    asr_decoder: !ref <dec>
+    beam_searcher: !ref <beam_searcher>
+
+pretrainer: !new:speechbrain.utils.parameter_transfer.Pretrainer
+    loadables:
+        asr: !ref <asr_model>
+        tokenizer: !ref <tokenizer>

normalizer.ckpt

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

tokenizer.ckpt

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