Update README.md

README.md

@@ -64,11 +64,137 @@ img {
 | [![Model size](https://img.shields.io/badge/Params-114M-lightgrey#model-badge)](#model-architecture)
 | [![Language](https://img.shields.io/badge/Language-en--US-lightgrey#model-badge)](#datasets)
 
-
-This model transcribes speech in lower case English alphabet along with spaces and apostrophes.
-It is an "extra-large" versions of Conformer-Transducer (around 600M parameters) model.  
+This collection contains large size versions of cache-aware FastConformer-Hybrid (around 114M parameters) with multiple look-ahead support, trained on a large scale english speech. 
+These models are trained for streaming ASR which be used for streaming applications with a variety of latencies. 
+All models are hybrid with both Transducer and CTC decoders. 
 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-transducer) for complete architecture details.
 
+
+## Model Architecture
+
+FastConformer [4] is an optimized version of the Conformer model [1]. The model is trained in a multitask setup with joint Transducer and CTC decoder loss. You may find more information on the details of FastConformer here: [Fast-Conformer Model](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/asr/models.html#fast-conformer) and about Hybrid Transducer-CTC training here: [Hybrid Transducer-CTC](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/asr/models.html#hybrid-transducer-ctc). You may find more on how to switch between the Transducer and CTC decoders in the documentations.
+
+These models are cache-aware versions of Hybrid FastConfomer which are trianed for streaming ASR. You may find more info on cache-aware models here: [Cache-aware Streaming Conformer](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/asr/models.html#cache-aware-streaming-conformer). The models are trained with multiple look-aheads which makes the model to be able to support different latencies. To learn on how to switch between different look-aheads, you may read the documentations on the cache-aware models.
+
+
+## Training
+
+The NeMo toolkit [3] was used for training the models for over several hundred epochs. These model are trained with this [example script](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/asr_hybrid_transducer_ctc/speech_to_text_hybrid_rnnt_ctc_bpe.py) and this [base config](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/conf/fastconformer/hybrid_cache_aware_streaming/fastconformer_hybrid_transducer_ctc_bpe_streaming.yaml). The SentencePiece tokenizers [2] for these models were 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).
+
+
+### Datasets
+
+All the models in this collection are trained on a composite dataset (NeMo ASRSET) comprising of several thousand hours of English speech:
+
+- Librispeech 960 hours of English speech
+- Fisher Corpus
+- Switchboard-1 Dataset
+- WSJ-0 and WSJ-1
+- National Speech Corpus (Part 1, Part 6)
+- VCTK
+- VoxPopuli (EN)
+- Europarl-ASR (EN)
+- Multilingual Librispeech (MLS EN) - 2,000 hours subset
+- Mozilla Common Voice (v7.0)
+- People's Speech - 12,000 hrs subset
+
+Note: older versions of the model may have trained on smaller set of datasets.
+
+## Performance
+
+The list of the available models in this collection is shown in the following tables for both CTC and Transducer decoders. Performances of the ASR models are reported in terms of Word Error Rate (WER%) with greedy decoding.
+
+### Transducer Decoder
+
+| Version | Tokenizer | Vocabulary Size | att_context_sizes | LS test-other ([70,13]-1040ms) | LS test-other ([70,6]-480ms) | LS test-other ([70,1]-80ms) | LS test-other ([70,0]-0s) | Train Dataset |
+|-----------|------------|----------|-----------------------|-----------------------|---------------|------------|-----------|----------------|
+| 1.20.0    | SPE Unigram| 1024     | [[70,13],[70,6],[70,1],[70,0]] | 5.4           | 5.7                        | 6.4                   | 7.0       | NeMo ASRSET 3.0 |
+
+### CTC Decoder
+
+| Version | Tokenizer | Vocabulary Size | att_context_sizes | LS test-other ([70,13]-1040ms) | LS test-other ([70,6]-480ms) | LS test-other ([70,1]-80ms) | LS test-other ([70,0]-0s) | Train Dataset |
+|-----------|------------|----------|--------|---------------|---------------|------------|-----------|----------------|
+| 1.20.0    | SPE Unigram| 1024     | [[70,13],[70,6],[70,1],[70,0]] | 6.2           | 6.7                        | 7.8                   | 8.4       | NeMo ASRSET 3.0 |
+
+
+## How to Use this Model
+
+The model is available for use in the NeMo toolkit [3], and can be used as a pre-trained checkpoint for streaming or for fine-tuning on another dataset. 
+
+To train, fine-tune 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']
+'''
+'''
+(if it causes an error): 
+pip install nemo_toolkit[all]
+``` 
+
+
+You may use this script to simulate streaming ASR with these models: [cache-aware streaming simulation](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/asr_cache_aware_streaming/speech_to_text_cache_aware_streaming_infer.py). 
+You may use --att_context_size to set the context size otherwise the default which is the first context size in the list is going to be used.
+
+### Automatically load the model from NGC
+
+```python
+import nemo.collections.asr as nemo_asr
+asr_model = nemo_asr.models.EncDecHybridRNNTCTCBPEModel.from_pretrained(model_name="stt_en_fastconformer_hybrid_large_streaming_multi")
+```
+
+### Transcribing text with this model
+
+Using Transducer mode inference:
+
+```shell
+python [NEMO_GIT_FOLDER]/examples/asr/transcribe_speech.py \
+  pretrained_name="stt_en_fastconformer_hybrid_large_streaming_multi" \
+  audio_dir="<DIRECTORY CONTAINING AUDIO FILES>"
+```
+
+Using CTC mode inference:
+
+```shell
+python [NEMO_GIT_FOLDER]/examples/asr/transcribe_speech.py \
+  pretrained_name="stt_en_fastconformer_hybrid_large_streaming_multi" \
+  audio_dir="<DIRECTORY CONTAINING AUDIO FILES>" \
+  decoder_type="ctc"
+```
+
+To change between different look-aheads you may set att_context_size of the script transcribe_speech.py as the following:
+
+```shell
+python [NEMO_GIT_FOLDER]/examples/asr/transcribe_speech.py \
+  pretrained_name="stt_en_fastconformer_hybrid_large_streaming_multi" \
+  audio_dir="<DIRECTORY CONTAINING AUDIO FILES>" \
+  att_context_size=[70,0]
+```
+
+### Input
+
+This model accepts 16000 KHz Mono-channel Audio (wav files) as input.
+
+### Output
+
+This model provides transcribed speech as a string for a given audio sample.
+
+## Limitations
+
+Since this model was trained on publically 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.
+
+
+## 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)
+
+[4] [Fast Conformer with Linearly Scalable Attention for Efficient Speech Recognition](https://arxiv.org/abs/2305.05084)
+
+
+
 ## NVIDIA NeMo: Training
 
 To train, fine-tune 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.