crdnn-model (#1)

- add crdnn model (b0587d015154adea8ea6514592c4f891c112289c)
- fix readme metadata (18beeab39287363a30927de57f854ba09caf4f08)
- update readme (a5b3ccf8103a1fe31f1c12072f3492bcd6408bb1)
- add example (b40aa419c018e5abf01d39d82a25dc9caa4b199d)


Co-authored-by: Dominik Wagner <dwgnr@users.noreply.huggingface.co>

.gitattributes

@@ -30,3 +30,6 @@ 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
+asr.ckpt filter=lfs diff=lfs merge=lfs -text
+normalizer.ckpt filter=lfs diff=lfs merge=lfs -text
+tokenizer.ckpt filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,131 @@
 ---
-license: apache-2.0
+language:
+- en
+thumbnail: null
+tags:
+- automatic-speech-recognition
+- CTC
+- Attention
+- pytorch
+- speechbrain
+license: "apache-2.0"
+datasets:
+- switchboard
+metrics:
+- wer
+- cer
+
 ---
+
+<iframe src="https://ghbtns.com/github-btn.html?user=speechbrain&repo=speechbrain&type=star&count=true&size=large&v=2" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
+<br/><br/>
+
+# CRDNN with CTC/Attention trained on Switchboard (No LM)
+
+This repository provides all the necessary tools to perform automatic speech recognition from an end-to-end system pretrained on Switchboard (EN) within SpeechBrain. 
+For a better experience we encourage you to learn more about [SpeechBrain](https://speechbrain.github.io). 
+
+The performance of the model is the following:
+
+| Release  | Swbd CER | Callhome CER | Eval2000 CER | Swbd WER | Callhome WER | Eval2000 WER | GPUs        |
+|:--------:|:--------:|:------------:|:------------:|:--------:|:------------:|:------------:|:-----------:|
+| 17-09-22 |  9.89   |  16.30       |  13.17       |  16.01     |  25.12     |  20.71       | 1xA100 40GB |
+
+
+## Pipeline description
+
+This ASR system is composed with 2 different but linked blocks:
+- Tokenizer (unigram) that transforms words into subword units trained on
+the training transcriptions of the Switchboard and Fisher corpus.
+- 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.
+
+The system is trained with recordings sampled at 16kHz (single channel).
+The code will automatically normalize your audio (i.e., resampling + mono channel selection) when calling `transcribe_file` if needed.
+
+## Install SpeechBrain
+
+First of all, please install SpeechBrain with the following command:
+
+```
+pip install speechbrain
+```
+
+Note 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-switchboard", savedir="pretrained_models/speechbrain/asr-crdnn-switchboard")
+asr_model.transcribe_file('speechbrain/asr-crdnn-switchboard/example.wav')
+
+```
+
+## Inference on GPU
+
+To perform inference on the GPU, add  `run_opts={"device":"cuda"}`  when calling the `from_hparams` method.
+
+## Parallel Inference on a Batch
+
+Please, [see this Colab notebook](https://colab.research.google.com/drive/1hX5ZI9S4jHIjahFCZnhwwQmFoGAi3tmu?usp=sharing) to figure out how to transcribe in parallel a batch of input sentences using a pre-trained model.
+
+## Training
+
+The model was trained with SpeechBrain (commit hash: `70904d0`).
+To train it from scratch follow these steps:
+
+1. Clone SpeechBrain:
+```bash
+git clone https://github.com/speechbrain/speechbrain/
+```
+
+2. Install it:
+```bash
+cd speechbrain
+pip install -r requirements.txt
+pip install -e .
+```
+
+3. Run Training:
+```bash
+cd recipes/Switchboard/ASR/seq2seq
+python train.py hparams/train_BPE_2000.yaml --data_folder=your_data_folder
+```
+
+## Limitations
+
+The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets. 
+
+## Credits
+
+This model was trained with resources provided by the [THN Center for AI](https://www.th-nuernberg.de/en/kiz). 
+
+# About SpeechBrain
+
+SpeechBrain is an open-source and all-in-one speech toolkit. It is designed to be simple, extremely flexible, and user-friendly. 
+Competitive or state-of-the-art performance is obtained in various domains.
+
+- Website: https://speechbrain.github.io/
+- GitHub: https://github.com/speechbrain/speechbrain/
+- HuggingFace: https://huggingface.co/speechbrain/
+
+# Citing SpeechBrain
+
+Please cite SpeechBrain if you use it for your research or business.
+
+```bibtex
+@misc{speechbrain,
+  title={{SpeechBrain}: A General-Purpose Speech Toolkit},
+  author={Mirco Ravanelli and Titouan Parcollet and Peter Plantinga and Aku Rouhe and Samuele Cornell and Loren Lugosch and Cem Subakan and Nauman Dawalatabad and Abdelwahab Heba and Jianyuan Zhong and Ju-Chieh Chou and Sung-Lin Yeh and Szu-Wei Fu and Chien-Feng Liao and Elena Rastorgueva and François Grondin and William Aris and Hwidong Na and Yan Gao and Renato De Mori and Yoshua Bengio},
+  year={2021},
+  eprint={2106.04624},
+  archivePrefix={arXiv},
+  primaryClass={eess.AS},
+  note={arXiv:2106.04624}
+}
+```

asr.ckpt

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

config.json

@@ -0,0 +1,3 @@
+{
+  "speechbrain_interface": "EncoderDecoderASR"
+}

hyperparams.yaml

@@ -0,0 +1,145 @@
+# ############################################################################
+# Model: E2E ASR with attention-based ASR
+# Encoder: CRDNN model
+# Decoder: GRU + beamsearch
+# Tokens: BPE with unigram
+# Losses: CTC + NLL
+# Training: Switchboard
+# Authors: Ju-Chieh Chou, Mirco Ravanelli, Abdel Heba, Peter Plantinga,
+# Samuele Cornell 2020, Dominik Wagner 2022
+# ############################################################################
+
+# Feature parameters
+sample_rate: 16000
+n_fft: 400
+n_mels: 40
+
+# Model parameters
+activation: !name:torch.nn.LeakyReLU
+dropout: 0.15
+cnn_blocks: 2
+cnn_channels: (128, 256)
+inter_layer_pooling_size: (2, 2)
+cnn_kernelsize: (3, 3)
+time_pooling_size: 4
+rnn_class: !name:speechbrain.nnet.RNN.LSTM
+rnn_layers: 4
+rnn_neurons: 1024
+rnn_bidirectional: True
+dnn_blocks: 2
+dnn_neurons: 512
+emb_size: 128
+dec_neurons: 1024
+output_neurons: 2000  # Number of tokens used for tokenizer
+blank_index: 0
+bos_index: 1
+eos_index: 2
+
+# Decoding parameters
+min_decode_ratio: 0.0
+max_decode_ratio: 1.0
+valid_beam_size: 60
+test_beam_size: 80
+eos_threshold: 1.5
+using_max_attn_shift: True
+max_attn_shift: 240
+ctc_weight_decode: 0.3
+coverage_penalty: 1.8
+temperature: 1.25
+
+normalizer: !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>
+   use_rnnp: False
+
+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: !ref <dec_neurons>
+   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
+
+tokenizer: !new:sentencepiece.SentencePieceProcessor
+
+asr_model: !new:torch.nn.ModuleList
+   - [!ref <enc>, !ref <emb>, !ref <dec>, !ref <ctc_lin>, !ref <seq_lin>]
+
+encoder: !new:speechbrain.nnet.containers.LengthsCapableSequential
+    input_shape: [null, null, !ref <n_mels>]
+    compute_features: !ref <compute_features>
+    normalize: !ref <normalizer>
+    model: !ref <enc>
+
+decoder: !new:speechbrain.decoders.S2SRNNBeamSearcher
+   embedding: !ref <emb>
+   decoder: !ref <dec>
+   linear: !ref <seq_lin>
+   ctc_linear: !ref <ctc_lin>
+   bos_index: !ref <bos_index>
+   eos_index: !ref <eos_index>
+   blank_index: !ref <blank_index>
+   min_decode_ratio: !ref <min_decode_ratio>
+   max_decode_ratio: !ref <max_decode_ratio>
+   beam_size: !ref <test_beam_size>
+   eos_threshold: !ref <eos_threshold>
+   using_max_attn_shift: !ref <using_max_attn_shift>
+   max_attn_shift: !ref <max_attn_shift>
+   coverage_penalty: !ref <coverage_penalty>
+   ctc_weight: !ref <ctc_weight_decode>
+   temperature: !ref <temperature>
+
+modules:
+    normalizer: !ref <normalizer>
+    encoder: !ref <encoder>
+    decoder: !ref <decoder>
+
+pretrainer: !new:speechbrain.utils.parameter_transfer.Pretrainer
+   loadables:
+      normalizer: !ref <normalizer>
+      asr: !ref <asr_model>
+      tokenizer: !ref <tokenizer>

normalizer.ckpt

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

tokenizer.ckpt

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