Update README.md

README.md

@@ -1,3 +1,133 @@
 ---
+language:
+- de
+thumbnail: null
+pipeline_tag: automatic-speech-recognition
+tags:
+- CTC
+- pytorch
+- speechbrain
+- Transformer
 license: apache-2.0
+datasets:
+- commonvoice
+metrics:
+- wer
+- cer
+model-index:
+- name: asr-wav2vec2-commonvoice-de
+  results:
+  - task:
+      name: Automatic Speech Recognition
+      type: automatic-speech-recognition
+    dataset:
+      name: CommonVoice Corpus 10.0/ (German)
+      type: mozilla-foundation/common_voice_10_1
+      config: de
+      split: test
+      args:
+        language: de
+    metrics:
+    - name: Test WER
+      type: wer
+      value: '9.54'
 ---
+
+<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/>
+
+# WavLM-large with CTC trained on CommonVoice German (No LM)
+
+This repository provides all the necessary tools to perform automatic speech
+recognition from an end-to-end system pretrained on CommonVoice (German Language) 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 | Test CER | Test WER | GPUs |
+|:-------------:|:--------------:|:--------------:| :--------:|
+| 16-08-22 | 2.24 | 8.98 | 1xRTXA6000 48GB |
+
+## Pipeline description
+
+This ASR system is composed of 2 different but linked blocks:
+- Tokenizer (char) that transforms words into chars and trained with
+the train transcriptions (train.tsv) of CommonVoice (DE).  
+- Acoustic model (wavlm + CTC). A pretrained wav2vec 2.0 model ([microsoft/wavlm-large](https://huggingface.co/microsoft/wavlm-large)) is combined with two DNN layers and finetuned on CommonVoice DE. 
+The obtained final acoustic representation is given to the CTC decoder.
+
+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 tranformers and SpeechBrain with the following command:
+
+```
+pip install speechbrain transformers
+```
+
+Please notice that we encourage you to read our tutorials and learn more about
+[SpeechBrain](https://speechbrain.github.io).
+
+### Transcribing your own audio files (in German)
+
+```python
+from speechbrain.pretrained import EncoderASR
+
+asr_model = EncoderASR.from_hparams(source="sangeet2020/asr-wavlm-large-commonvoice-de", savedir="pretrained_models/asr-wavlm-large-commonvoice-de")
+asr_model.transcribe_file("sangeet2020/asr-wavlm-large-commonvoice-de/example-de.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.
+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/CommonVoice/ASR/seq2seq
+python train.py hparams/train_de_with_wav2vec.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.
+
+
+# **About SpeechBrain**
+- Website: https://speechbrain.github.io/
+- Code: 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}
+}
+```