added model card for canary-1b-flash

Signed-off-by: Kunal Dhawan <[email protected]>

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+canary-1b-flash.nemo filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,504 @@
 ---
 license: cc-by-4.0
+language:
+- en
+- de
+- es
+- fr
+library_name: nemo
+datasets:
+- librispeech_asr
+- fisher_corpus
+- Switchboard-1
+- WSJ-0
+- WSJ-1
+- National-Singapore-Corpus-Part-1
+- National-Singapore-Corpus-Part-6
+- vctk
+- voxpopuli
+- europarl
+- multilingual_librispeech
+- mozilla-foundation/common_voice_8_0
+- MLCommons/peoples_speech
+thumbnail: null
+tags:
+- automatic-speech-recognition
+- automatic-speech-translation
+- speech
+- audio
+- Transformer
+- FastConformer
+- Conformer
+- pytorch
+- NeMo
+- hf-asr-leaderboard
+widget:
+- example_title: Librispeech sample 1
+  src: https://cdn-media.huggingface.co/speech_samples/sample1.flac
+- example_title: Librispeech sample 2
+  src: https://cdn-media.huggingface.co/speech_samples/sample2.flac
+model-index:
+- name: canary-1b-flash
+  results:
+  - task:
+      name: Automatic Speech Recognition
+      type: automatic-speech-recognition
+    dataset:
+      name: LibriSpeech (other)
+      type: librispeech_asr
+      config: other
+      split: test
+      args:
+        language: en
+    metrics:
+    - name: Test WER
+      type: wer
+      value: 2.87
+  - task:
+      type: Automatic Speech Recognition
+      name: automatic-speech-recognition
+    dataset:
+      name: SPGI Speech
+      type: kensho/spgispeech
+      config: test
+      split: test
+      args:
+        language: en
+    metrics:
+    - name: Test WER
+      type: wer
+      value: 1.95
+  - task:
+      type: Automatic Speech Translation
+      name: automatic-speech-translation
+    dataset:
+      name: FLEURS
+      type: google/fleurs
+      config: en_us
+      split: test
+      args:
+        language: en-de
+    metrics:
+    - name: Test BLEU (En->De)
+      type: bleu
+      value: 32.27
+  - task:
+      type: Automatic Speech Translation
+      name: automatic-speech-translation
+    dataset:
+      name: FLEURS
+      type: google/fleurs
+      config: en_us
+      split: test
+      args:
+        language: en-de
+    metrics:
+    - name: Test BLEU (En->Es)
+      type: bleu
+      value: 22.6
+  - task:
+      type: Automatic Speech Translation
+      name: automatic-speech-translation
+    dataset:
+      name: FLEURS
+      type: google/fleurs
+      config: en_us
+      split: test
+      args:
+        language: en-de
+    metrics:
+    - name: Test BLEU (En->Fr)
+      type: bleu
+      value: 41.22
+  - task:
+      type: Automatic Speech Translation
+      name: automatic-speech-translation
+    dataset:
+      name: FLEURS
+      type: google/fleurs
+      config: de_de
+      split: test
+      args:
+        language: de-en
+    metrics:
+    - name: Test BLEU (De->En)
+      type: bleu
+      value: 35.5
+  - task:
+      type: Automatic Speech Translation
+      name: automatic-speech-translation
+    dataset:
+      name: FLEURS
+      type: google/fleurs
+      config: es_419
+      split: test
+      args:
+        language: es-en
+    metrics:
+    - name: Test BLEU (Es->En)
+      type: bleu
+      value: 23.32
+  - task:
+      type: Automatic Speech Translation
+      name: automatic-speech-translation
+    dataset:
+      name: FLEURS
+      type: google/fleurs
+      config: fr_fr
+      split: test
+      args:
+        language: fr-en
+    metrics:
+    - name: Test BLEU (Fr->En)
+      type: bleu
+      value: 33.42
+  - task:
+      type: Automatic Speech Translation
+      name: automatic-speech-translation
+    dataset:
+      name: COVOST
+      type: covost2
+      config: de_de
+      split: test
+      args:
+        language: de-en
+    metrics:
+    - name: Test BLEU (De->En)
+      type: bleu
+      value: 39.33
+  - task:
+      type: Automatic Speech Translation
+      name: automatic-speech-translation
+    dataset:
+      name: COVOST
+      type: covost2
+      config: es_419
+      split: test
+      args:
+        language: es-en
+    metrics:
+    - name: Test BLEU (Es->En)
+      type: bleu
+      value: 41.86
+  - task:
+      type: Automatic Speech Translation
+      name: automatic-speech-translation
+    dataset:
+      name: COVOST
+      type: covost2
+      config: fr_fr
+      split: test
+      args:
+        language: fr-en
+    metrics:
+    - name: Test BLEU (Fr->En)
+      type: bleu
+      value: 41.43
+  
+metrics:
+- wer
+- bleu
+pipeline_tag: automatic-speech-recognition
 ---
+
+# Canary 1B Flash
+
+<style>
+img {
+ display: inline;
+}
+</style>
+
+## Description:
+NVIDIA NeMo Canary [1] is a family of multilingual multi-tasking models that achieves state-of-the art performance on multiple speech benchmarks. With 883 million parameters and running at 900+ RTFx, canary-1b-flash supports automatic speech-to-text recognition (ASR) in 4 languages (English, German, French, Spanish) and translation from English to German/French/Spanish and from German/French/Spanish to English with or without punctuation and capitalization (PnC). In addition to this, canary-1b-flash also supports functionality for word-level timestamps for English, German, French, and Spanish. This model is ready for commercial use.
+
+### License/Terms of Use: 
+canary-1b-flash is released under the CC-BY-4.0 license. By using this model, you are agreeing to the [terms and conditions](https://choosealicense.com/licenses/cc-by-4.0/) of the license. <br>
+
+## References:
+[1] [Less is More: Accurate Speech Recognition & Translation without Web-Scale Data](https://www.isca-archive.org/interspeech_2024/puvvada24_interspeech.pdf) <br>
+[2] [Fast Conformer with Linearly Scalable Attention for Efficient Speech Recognition](https://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=10389701)
+
+[3] [Attention Is All You Need](https://arxiv.org/abs/1706.03762)
+
+[4] [Unified Model for Code-Switching Speech Recognition and Language Identification Based on Concatenated Tokenizer](https://aclanthology.org/2023.calcs-1.7.pdf)
+
+[5] [Google Sentencepiece Tokenizer](https://github.com/google/sentencepiece)
+
+[6] [NVIDIA NeMo Toolkit](https://github.com/NVIDIA/NeMo)
+
+[7] [EMMeTT: Efficient Multimodal Machine Translation Training](https://arxiv.org/abs/2409.13523)
+
+[8] [Towards Measuring Fairness in AI: the Casual Conversations Dataset](https://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=9634168)
+
+## Model Architecture:
+Canary is an encoder-decoder model with FastConformer [2] Encoder and Transformer Decoder [3]. With audio features extracted from the encoder, task tokens such as \<target language\>, \<task\>, \<toggle timestamps\> and \<toggle PnC\> are fed into the Transformer Decoder to trigger the text generation process. Canary uses a concatenated tokenizer [4] from individual SentencePiece [5] tokenizers of each language, which makes it easy to scale up to more languages. The canary-1b-flash model has 32 encoder layers and 4 layers of decoder layers, leading to a total of 883M parameters.
+
+## NVIDIA NeMo
+
+To train, fine-tune or transcribe with canary-1b-flash, you will need to install [NVIDIA NeMo](https://github.com/NVIDIA/NeMo).
+
+## How to Use this Model
+
+The model is available for use in the NeMo toolkit [4], and can be used as a pre-trained checkpoint for inference or for fine-tuning on another dataset.
+
+### Loading the Model
+
+```python
+from nemo.collections.asr.models import EncDecMultiTaskModel
+# load model
+canary_model = EncDecMultiTaskModel.from_pretrained('nvidia/canary-1b-flash')
+# update dcode params
+decode_cfg = canary_model.cfg.decoding
+decode_cfg.beam.beam_size = 1
+canary_model.change_decoding_strategy(decode_cfg)
+```
+
+## Input: 
+**Input Type(s):** Audio <br>
+**Input Format(s):** .wav or .flac files<br>
+**Input Parameters(s):** 1D <br>
+**Other Properties Related to Input:** 16000 Hz Mono-channel Audio, Pre-Processing Not Needed <br>
+
+Input to canary-1b-flash can be either a list of paths to audio files or a jsonl manifest file.
+
+If the input is a list of paths, canary-1b-flash assumes that the audio is English and transcribes it. I.e., canary-1b-flash default behavior is English ASR. 
+```python
+predicted_text = canary_model.transcribe(
+    paths2audio_files=['path1.wav', 'path2.wav'],
+    batch_size=16,  # batch size to run the inference with
+)
+```
+
+To use canary-1b-flash for transcribing other supported languages or perform Speech-to-Text translation or provide word-level timestamps, specify the input as jsonl manifest file, where each line in the file is a dictionary containing the following fields: 
+
+```yaml
+# Example of a line in input_manifest.json
+{
+    "audio_filepath": "/path/to/audio.wav",  # path to the audio file
+    "duration": 1000,  # duration of the audio, can be set to `None` if using NeMo main branch
+    "taskname": "asr",  # use "s2t_translation" for speech-to-text translation with r1.23, or "ast" if using the NeMo main branch
+    "source_lang": "en",  # language of the audio input, set `source_lang`==`target_lang` for ASR, choices=['en','de','es','fr']
+    "target_lang": "en",  # language of the text output, choices=['en','de','es','fr']
+    "pnc": "yes",  # whether to have PnC output, choices=['yes', 'no']
+    "timestamp": "yes", # whether to output word-levl timestamps, choices=['yes', 'no']
+}
+```
+
+and then use:
+```python
+predicted_text = canary_model.transcribe(
+    "<path to input manifest file>",
+    batch_size=16,  # batch size to run the inference with
+)
+```
+
+## Output:
+**Output Type(s):** Text <br>
+**Output Format:** Text output as a string (w/ timestamps) depending on the task chosen for decoding <br> 
+**Output Parameters:** 1-Dimensional text string <br>
+**Other Properties Related to Output:** May Need Inverse Text Normalization; Does Not Handle Special Characters <br>
+
+
+## Software Integration:
+**Runtime Engine(s):** 
+* NeMo - 2.1.0 or higher <br>
+
+**Supported Hardware Microarchitecture Compatibility:** <br>
+* [NVIDIA Ampere] <br>
+* [NVIDIA Blackwell] <br>
+* [NVIDIA Jetson]  <br>
+* [NVIDIA Hopper] <br>
+* [NVIDIA Lovelace] <br>
+* [NVIDIA Pascal] <br>
+* [NVIDIA Turing] <br>
+* [NVIDIA Volta] <br>
+
+**[Preferred/Supported] Operating System(s):** <br>
+* [Linux] <br>
+* [Linux 4 Tegra] <br>
+* [Windows] <br>
+
+## Model Version(s): 
+canary-1b-flash <br>
+
+
+# Training and Evaluation Datasets: 
+
+## Training Dataset:
+
+The canary-1b-flash model is trained on a total of 85K hrs of speech data. It consists of 31K hrs of public data, 20K hrs collected by [Suno](https://suno.ai/), and 34K hrs of in-house data. 
+The datasets below include conversations, videos from the web and audiobook recordings.
+
+**Data Collection Method:**
+* Human <br>
+
+**Labeling Method:**
+* Hybrid: Human, Automated <br>
+
+The constituents of public data are as follows. 
+
+#### English (25.5k hours)
+- Librispeech 960 hours
+- 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 hour subset
+- Mozilla Common Voice (v7.0)
+- People's Speech - 12,000 hour subset
+- Mozilla Common Voice (v11.0)  - 1,474 hour subset
+
+#### German (2.5k hours)
+- Mozilla Common Voice (v12.0)  - 800 hour subset
+- Multilingual Librispeech (MLS DE) - 1,500 hour subset
+- VoxPopuli (DE) - 200 hr subset
+
+#### Spanish (1.4k hours)
+- Mozilla Common Voice (v12.0)  - 395 hour subset
+- Multilingual Librispeech (MLS ES) - 780 hour subset
+- VoxPopuli (ES) - 108 hour subset
+- Fisher  - 141 hour subset
+
+#### French (1.8k hours)
+- Mozilla Common Voice (v12.0)  - 708 hour subset
+- Multilingual Librispeech (MLS FR) - 926 hour subset
+- VoxPopuli (FR) - 165 hour subset
+
+
+## Evaluation Dataset:
+
+**Data Collection Method:** <br>
+* Human <br>
+
+**Labeling Method:** <br>
+* Human <br>
+
+Automatic Speech Recognition: 
+* [HuggingFace OpenASR Leaderboard evaluation sets](https://huggingface.co/spaces/hf-audio/open_asr_leaderboard)
+* [MLS](https://huggingface.co/datasets/facebook/multilingual_librispeech)
+
+Automatic Speech Translation:
+* [FLEURS](https://huggingface.co/datasets/google/fleurs)
+* [COVOST-v2](https://github.com/facebookresearch/covost)
+* [mExpresso](https://huggingface.co/facebook/seamless-expressive#mexpresso-multilingual-expresso)
+
+Timestamp Prediction:
+* [Librispeech](https://www.openslr.org/12)
+
+Hallucination Robustness:
+* [MUSAN](https://www.openslr.org/17/) 48 hrs eval set
+
+Noise Robustness:
+* [Librispeech](https://www.openslr.org/12)
+
+Model Fairness:
+* [Casual Conversations Dataset](https://arxiv.org/pdf/2104.02821)
+
+## Training
+
+canary-1b-flash is trained using the NVIDIA NeMo toolkit [6] for a total of 200K steps with 2D bucketing [7] and optimal batch sizes set using OOMptimizer [7].The model is trained on 128 NVIDIA A100 80GB GPUs. 
+The model can be trained using this [example script](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/speech_multitask/speech_to_text_aed.py) and [base config](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/conf/speech_multitask/fast-conformer_aed.yaml).
+
+The tokenizers 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).
+
+## Inference:
+**Engine:** NVIDIA NeMo <br>
+**Test Hardware :** <br>
+* A6000 <br>
+* A100 <br>
+* V100 <br>
+
+## Performance
+
+In both ASR and AST experiments, predictions were generated using beam search with width 5 and length penalty 1.0.
+
+### ASR Performance (w/o PnC) 
+
+The ASR performance is measured with word error rate (WER), and we process the groundtruth and predicted text with [whisper-normalizer](https://pypi.org/project/whisper-normalizer/).
+
+WER on [HuggingFace OpenASR leaderboard](https://huggingface.co/spaces/hf-audio/open_asr_leaderboard):
+
+| **Version** | **Model**     | **RTFx**   | **AMI**   | **GigaSpeech**   | **LS Clean**   | **LS Other**   | **Earnings22**   | **SPGISpech**   | **Tedlium**   | **Voxpopuli**   |
+|:---------:|:-----------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:|
+| 2.2.0  | canary-1b-flash | 928.19 | 13.08 | 9.88 | 1.48 | 2.87 | 12.77 | 1.95 | 3.09 | 5.64 |
+
+
+WER on [MLS](https://huggingface.co/datasets/facebook/multilingual_librispeech) test set:
+
+| **Version** | **Model**  | **De**   | **Es**   | **Fr**   |
+|:---------:|:-----------:|:------:|:------:|:------:|
+| 2.2.0   | canary-1b-flash | 4.36 | 2.69 | 4.47 |
+
+
+More details on evaluation can be found at [HuggingFace ASR Leaderboard](https://huggingface.co/spaces/hf-audio/open_asr_leaderboard)
+
+### AST Performance
+
+We evaluate AST performance with [BLEU score](https://lightning.ai/docs/torchmetrics/stable/text/sacre_bleu_score.html), and use native annotations with punctuation and capitalization in the datasets.
+
+BLEU score on [FLEURS](https://huggingface.co/datasets/google/fleurs) test set:
+
+| **Version** | **Model** | **En->De** | **En->Es** | **En->Fr** | **De->En** | **Es->En** | **Fr->En** |
+|:-----------:|:---------:|:----------:|:----------:|:----------:|:----------:|:----------:|:----------:|
+| 2.2.0       | canary-1b-flash | 	32.27   |  22.6   |   41.22    |   35.5   |   23.32    |   33.42    |
+
+
+BLEU score on [COVOST-v2](https://github.com/facebookresearch/covost) test set:
+
+| **Version** | **Model** | **De->En** | **Es->En** | **Fr->En** |
+|:-----------:|:---------:|:----------:|:----------:|:----------:|
+| 2.2.0       | canary-1b-flash |   39.33   |    41.86    |   41.43    |
+
+BLEU score on [mExpresso](https://huggingface.co/facebook/seamless-expressive#mexpresso-multilingual-expresso) test set:
+
+| **Version** | **Model** | **En->De** | **En->Es** | **En->Fr** |
+|:-----------:|:---------:|:----------:|:----------:|:----------:|
+| 2.2.0       | canary-1b-flash |   22.91    |   35.69   |   27.85   |
+
+### Timestamp Prediction
+F1-score on [Librispeech Test sets](https://www.openslr.org/12) at collar value of 200ms
+| **Version** | **Model** | **test-clean** | **test-other** |
+|:-----------:|:---------:|:----------:|:----------:|
+| 2.2.0       | canary-1b-flash |   95.5    |   93.5   |
+
+### Hallucination Robustness
+Number of characters per minute on [MUSAN](https://www.openslr.org/17) 48 hrs eval set
+| **Version** | **Model** | **# of character per minute** |
+|:-----------:|:---------:|:----------:|
+| 2.2.0       | canary-1b-flash |   60.92   |
+
+### Noise Robustness
+WER on [Librispeech Test Clean](https://www.openslr.org/12) at different SNR (signal to noise ratio) levels of additive white noise
+
+| **Version** | **Model** | **SNR 10** | **SNR 5** | **SNR 0** | **SNR -5** |
+|:-----------:|:---------:|:----------:|:----------:|:----------:|:----------:|
+| 2.2.0       | canary-1b-flash |    2.34   |   3.69   |   8.84   |    29.71  |
+
+## Model Fairness Evaluation
+
+As outlined in the paper "Towards Measuring Fairness in AI: the Casual Conversations Dataset" [8], we assessed the canary-1b-flash model for fairness. The model was evaluated on the CausalConversations-v1 dataset, and the results are reported as follows:
+
+### Gender Bias:
+
+| Gender | Male | Female | N/A | Other |
+| :--- | :--- | :--- | :--- | :--- |
+| Num utterances | 19325 | 24532 | 926 | 33 |
+| % WER | 14.66 | 12.44 | 17.17 | 27.56 |
+
+### Age Bias:
+
+| Age Group | (18-30) | (31-45) | (46-85) | (1-100) |
+| :--- | :--- | :--- | :--- | :--- |
+| Num utterances | 15956 | 14585 | 13349 | 43890 |
+| % WER | 13.18 | 13.45 | 13.64 | 13.41 |
+
+(Error rates for fairness evaluation are determined by normalizing both the reference and predicted text, similar to the methods used in the evaluations found at https://github.com/huggingface/open_asr_leaderboard.)
+
+## Ethical Considerations:
+NVIDIA believes Trustworthy AI is a shared responsibility and we have established policies and practices to enable development for a wide array of AI applications.  When downloaded or used in accordance with our terms of service, developers should work with their internal model team to ensure this model meets requirements for the relevant industry and use case and addresses unforeseen product misuse.  
+Please report security vulnerabilities or NVIDIA AI Concerns [here](https://www.nvidia.com/en-us/support/submit-security-vulnerability/).
+