# Speech Recognition: CitriNet Model Card ========================================

# Model Overview --------------

CitriNet models are end-to-end neural automatic speech recognition (ASR) models that transcribe segments of audio to text.

# Model Architecture ------------------

Citrinet is a version of [QuartzNet](https://arxiv.org/pdf/1910.10261.pdf) that extends [ContextNet](https://arxiv.org/pdf/2005.03191.pdf), utilizing subword encoding (via Word Piece tokenization) and Squeeze-and-Excitation(SE) mechanism and are therefore smaller than QuartzNet models.

CitriNet models take in audio segments and transcribe them to letter, byte pair, or word piece sequences.
The pretrained models here can be used immediately for fine-tuning or dataset evaluation.

# Intended Use ------------

Primary use case intended for these models is automatic speech recognition.

Input:
Single-channel audio files (WAV) with a 16kHz sample rate

Output:
Transcripts, which are sequences of valid vocabulary labels as given by the specification file

# How to Use This Model ---------------------

CitriNet is an end-to-end architecture that is trained using CTC loss.
These model checkpoints are intended to be used with the Train Adapt Optimize (TAO) Toolkit.
In order to use these checkpoints, there should be a specification file (.yaml) that specifies hyperparameters, datasets for training and evaluation, and any other information needed for the experiment.
For more information on the experiment spec files for each use case, please refer to the [TAO Toolkit User Guide](https://docs.nvidia.com/tao/tao-toolkit/text/overview.html).

The models are encrypted with the key `tlt_encode`.

To fine-tune from a model checkpoint (.tlt), use the following command:

```sh
!tao speech_to_text_citrinet finetune -e \
 -m \
 -g \
 -r 
```

Where the `` parameter should be a valid path to the file that specifies the fine-tuning hyperparameters, the dataset to fine-tune on, the dataset to evaluate on, and whether or not a change of vocabulary from the default (lowercase English letters, space, and apostrophe) is needed.

To evaluate an existing dataset using a model checkpoint (.tlt), use the following command:

```sh
!tao speech_to_text_citrinet evaluate -e \
 -m \
 -g \
 -r 
```

The `` parameter should be a valid path to the file that specifies the dataset that is being evaluated.

# Training Information --------------------

The model was trained on various proprietary and open-source datasets. These datasets include noisy data,
multiple sampling rates including 8khz for call centers, variety of accents, domain specific data for various
domains, spontaneous speech and dialogue, all of which contribute to the model’s accuracy.

This model delivers WER that is better than or comparable to popular alternate Speech to Text solutions
for a range of domains and use cases.

# Limitations -----------

Currently, TAO CitriNet models only support training and inference on .wav audio files.
All models included here were trained and evaluated on audio files with a sample rate of 16kHz, so for best performance you may need to upsample or downsample audio files to 16kHz.

In addition, the model will perform best on audio samples that are longer than 0.1 seconds long.
For training and fine-tuning CitriNet models, it is recommended that samples are capped at a maximum length of around 15 seconds, depending on the amount of memory available to you.
You do not need to place a maximum length limitation for evaluation.

# License -------

By downloading and using the models and resources packaged with TAO Conversational AI, you would be accepting the terms of the Riva [license](https://developer.nvidia.com/riva/license)

# Suggested Reading -----------------

- More information about the TAO Toolkit can be found at the NVIDIA Developer Zone: https://developer.nvidia.com/tao-toolkit
- Read the [TAO getting Started guide](https://docs.nvidia.com/tao/tao-toolkit/text/tao_quick_start_guide.html) and [release notes](https://docs.nvidia.com/tao/tao-toolkit/text/release_notes.html).
- More information about the experiment spec files can be found in the [TAO User Guide](https://docs.nvidia.com/tao/tao-toolkit/text/overview.html)

# Ethical AI ----------

NVIDIA’s platforms and application frameworks enable developers to build a wide array of AI applications.
Consider potential algorithmic bias when choosing or creating the models being deployed.
Work with the model’s developer to ensure that it meets the requirements for the relevant industry and use case;
that the necessary instruction and documentation are provided to understand error rates, confidence intervals, and results; and that the model is being used under the conditions and in the manner intended.


speechtotext_english_citrinet

Speech to Text Citrinet models for English.

Speech to Text English Citrinet

Description

Publisher

Use Case

Framework

Latest Version

Modified

Size