Update README.md

README.md

@@ -1,3 +1,86 @@
 ---
+language:
+- ua
+library_name: nemo
+datasets:
+- MCV-10
+tags:
+- automatic-speech-recognition
+- speech
+- audio
+- CTC
+- Citrinet
+- Transformer
+- pytorch
+- NeMo
+- hf-asr-leaderboard
+- Riva
 license: cc-by-4.0
 ---
+
+<style>
+img {
+ display: inline;
+}
+</style>
+
+| [![Model architecture](https://img.shields.io/badge/Model_Arch-Citrinet--CTC-lightgrey#model-badge)](#model-architecture)
+| [![Model size](https://img.shields.io/badge/Params-140M-lightgrey#model-badge)](#model-architecture)
+| [![Language](https://img.shields.io/badge/Language-ua-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 in lowercase Ukrainian alphabet including spaces and apostrophes, and is trained on 69 hours of Ukrainian speech data.
+It is a non-autoregressive "large" variant of Streaming Citrinet, with around 140 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).
+
+## 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 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 the latest PyTorch version.
+
+```
+pip install nemo_toolkit['all']
+```
+
+### 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.
+
+## Model Architecture
+
+Streaming Citrinet-1024 model is a non-autoregressive, streaming variant of Citrinet model [1] for Automatic Speech Recognition which uses CTC loss/decoding instead of Transducer. You may find more info on this model here: [Citrinet Model](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/asr/models.html#citrinet).
+
+## Training
+
+The NeMo toolkit [3] was used for training the model for over several hundred epochs. This model was trained 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/citrinet/citrinet_1024.yaml).
+
+The tokenizer for this models 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).
+
+### Datasets
+
+Model was trained on Mozilla Common Voice Corpus 10.0 dataset comprising of 69 hours of Ukrainian speech.
+
+## Limitations
+
+Since this model was trained on publicly available speech datasets, the performance of this model might degrade for speech that 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] [Citrinet: Closing the Gap between Non-Autoregressive and Autoregressive End-to-End Models for Automatic Speech Recognition](https://arxiv.org/abs/2104.01721) <br />
+[2] [Google Sentencepiece Tokenizer](https://github.com/google/sentencepiece) <br />
+[3] [NVIDIA NeMo Toolkit](https://github.com/NVIDIA/NeMo)