Update README.md

README.md

@@ -1,3 +1,142 @@
 ---
+language:
+- eo
+library_name: nemo
+datasets:
+- mozilla-foundation/common_voice_11_0
+thumbnail: null
+tags:
+- automatic-speech-recognition
+- speech
+- audio
+- CTC
+- Conformer
+- Transformer
+- pytorch
+- NeMo
+- hf-asr-leaderboard
+- Riva
 license: cc-by-4.0
+model-index:
+- name: stt_eo_conformer_ctc_large
+  results:
+  - task:
+      name: Automatic Speech Recognition
+      type: automatic-speech-recognition
+    dataset:
+      name: Mozilla Common Voice 11.0
+      type: mozilla-foundation/common_voice_11_0
+      config: eo
+      split: test
+      args:
+        language: eo
+    metrics:
+    - name: Dev WER
+      type: wer
+      value: 2.9    
+    - name: Test WER
+      type: wer
+      value: 4.8
 ---
+
+# NVIDIA Conformer-CTC Large (Esperanto)
+
+<style>
+img {
+ display: inline;
+}
+</style>
+
+| [![Model architecture](https://img.shields.io/badge/Model_Arch-Conformer--CTC-lightgrey#model-badge)](#model-architecture)
+| [![Model size](https://img.shields.io/badge/Params-120M-lightgrey#model-badge)](#model-architecture)
+| [![Language](https://img.shields.io/badge/Language-eo-lightgrey#model-badge)](#datasets)
+| [![Riva Compatible](https://img.shields.io/badge/NVIDIA%20Riva-compatible-brightgreen#model-badge)](#deployment-with-nvidia-riva) |
+
+
+This model transcribes speech into lowercase Esperanto alphabet including spaces and apostroph. The model was obtained by finetuning from English SSL-pretrained model on Mozilla Common Voice Esperanto 11.0 dataset. It is a non-autoregressive "large" variant of Conformer [1], with around 120 million parameters. See the [model architecture](#model-architecture) section and [NeMo documentation](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/asr/models.html#conformer-ctc) for complete architecture details.
+It is also compatible with NVIDIA Riva for [production-grade server deployments](#deployment-with-nvidia-riva). 
+
+The Esperanto model utilizes a Google SentencePiece [2] tokenizer with vocabulary size 128
+
+## Usage
+
+The model is available for use in the NeMo toolkit [3], and can be used as a pre-trained checkpoint for inference or for finetuning on another dataset.
+
+To train, finetune or play with the model you will need to install [NVIDIA NeMo](https://github.com/NVIDIA/NeMo). We recommend you install it after you've installed latest PyTorch version.
+
+```
+pip install nemo_toolkit['all']
+```
+
+### Automatically instantiate the model
+
+```python
+import nemo.collections.asr as nemo_asr
+asr_model = nemo_asr.models.EncDecCTCModelBPE.from_pretrained("nvidia/stt_eo_conformer_ctc_large")
+```
+
+### Transcribing using Python
+Simply do:
+```
+asr_model.transcribe(['<your_audio>.wav'])
+```
+
+### Transcribing many audio files
+
+```shell
+python [NEMO_GIT_FOLDER]/examples/asr/transcribe_speech.py 
+ pretrained_name="nvidia/stt_eo_conformer_ctc_large" 
+ audio_dir="<DIRECTORY CONTAINING AUDIO FILES>"
+```
+
+### Input
+
+This model accepts 16 kHz mono-channel Audio (wav files) as input.
+
+### Output
+
+This model provides transcribed speech as a string for a given audio sample.
+
+## Model Architecture
+
+Conformer-CTC model is a non-autoregressive variant of Conformer model [1] for Automatic Speech Recognition which uses CTC loss/decoding instead of Transducer. You may find more info on the detail of this model here: [Conformer-CTC Model](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/asr/models.html#conformer-ctc). 
+
+## Training
+
+The NeMo toolkit [3] was used for finetuning from English SSL model for three hundred epochs. The model is finetuning with this [example script](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/asr_ctc/speech_to_text_ctc_bpe.py) and this [base config](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/conf/conformer/conformer_ctc_bpe.yaml). As pretrained English SSL model we use [ssl_en_conformer_large](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/nemo/models/ssl_en_conformer_large) which was trained using LibriLight corpus (~56k hrs of unlabeled English speech).
+
+The tokenizer (BPE vocab size 128) for the model was built using the text transcripts of the train set with this [script](https://github.com/NVIDIA/NeMo/blob/main/scripts/tokenizers/process_asr_text_tokenizer.py).
+
+Full config can be found inside the .nemo files.
+
+More training details can be found at the [Esperanto ASR example](https://github.com/andrusenkoau/NeMo/blob/esperanto_example/docs/source/asr/examples/esperanto_asr/esperanto_asr.rst).
+
+### Datasets
+
+All the models were trained on a Mozilla Common Voice Esperanto 11.0 dataset comprising of about 1400 validated hours of Esperanto speech. However, training set consists of a much smaller amount of data, because when forming the train.tsv, dev.tsv and test.tsv, repetitions of texts in train were removed by Mozilla developers.
+
+- Train set: ~250 hours.
+- Dev set:    ~25 hours.
+- Test:       ~25 hours.
+
+## Performance
+
+The list of the available models in this collection is shown in the following table. Performances of the ASR models are reported in terms of Word Error Rate (WER%) with greedy decoding.
+
+| Version | Tokenizer             | Vocabulary Size | Dev WER| Test WER| Train Dataset   |
+|---------|-----------------------|-----------------|--------|---------|-----------------|
+| 1.14.0  | SentencePiece BPE     | 128             |  2.9   |    4.8  | MCV-11.0 Train set |
+
+## Limitations
+Since this model was trained on publicly available speech datasets, the performance of this model might degrade for speech which includes technical terms, or vernacular that the model has not been trained on. The model might also perform worse for accented speech.
+## Deployment with NVIDIA Riva
+For the best real-time accuracy, latency, and throughput, deploy the model with [NVIDIA Riva](https://developer.nvidia.com/riva), an accelerated speech AI SDK deployable on-prem, in all clouds, multi-cloud, hybrid, at the edge, and embedded. 
+Additionally, Riva provides: 
+* World-class out-of-the-box accuracy for the most common languages with model checkpoints trained on proprietary data with hundreds of thousands of GPU-compute hours 
+* Best in class accuracy with run-time word boosting (e.g., brand and product names) and customization of acoustic model, language model, and inverse text normalization 
+* Streaming speech recognition, Kubernetes compatible scaling, and Enterprise-grade support 
+Check out [Riva live demo](https://developer.nvidia.com/riva#demos).
+## References
+- [1] [Conformer: Convolution-augmented Transformer for Speech Recognition](https://arxiv.org/abs/2005.08100)
+- [2] [Google Sentencepiece Tokenizer](https://github.com/google/sentencepiece)
+- [3] [NVIDIA NeMo Toolkit](https://github.com/NVIDIA/NeMo)