parthiv11
/

stt_hi_conformer_ctc_large_v2

Automatic Speech Recognition

NeMo

Hindi

Eval Results

Model card Files Files and versions Community

parthiv11 commited on Feb 28

Commit

83982d7

•

1 Parent(s): ce82e74

Update README.md

Browse files

Files changed (1) hide show

README.md +35 -177

README.md CHANGED Viewed

@@ -15,201 +15,59 @@ model-index:
     - type: wer
       value: 8.1
       name: WER
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

     - type: wer
       value: 8.1
       name: WER
+language:
+- hi
+metrics:
+- wer
+library_name: nemo
+pipeline_tag: automatic-speech-recognition
 ---
+## Model Overview
+This collection contains large size versions of Conformer-CTC (around 120M parameters) trained on ULCA & Europal with around ~2900 hours. The model transcribes speech in Hindi characters along with spaces for Hinglish speech.
+## Model Architecture
+Conformer-CTC model is a non-autoregressive variant of Conformer model for Automatic Speech Recognition which uses CTC loss/decoding instead of Transducer. You may find more info on the detail of this model [here](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/asr/models.html).
+## 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/speech_to_text_bpe.py) and [this base config](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/conf/conformer/conformer_ctc_bpe.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).
+The checkpoint of the language model used as the neural rescorer.
+### Datasets
+All the models in this collection are trained on Hindi labelled dataset (~2900 hrs):
+- ULCA Hindi Corpus
+- Europal Dataset
+## 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 and 6-Gram KenLM trained on AI4Bharat Corpus and Europal.
+| Decoding        | Version | Tokenizer           | Vocabulary Size | MUCS 2021 Blind Test* | IITM 2020 Eval Set | IITM 2020 Dev Set | Common Voice 6 Test* | Common Voice 7 Test* | Common Voice 8 Test* |
+|-----------------|---------|---------------------|-----------------|------------------------|--------------------|-------------------|----------------------|----------------------|----------------------|
+| Greedy          | 1.10.0  | SentencePiece Unigram | 128           | 9.37%/2.74%            | 12.93%/5.60%       | 12.63%/5.49%      | 13.16%/4.5%          | 13.5%/5.2%           | 14.37%/5.95%         |
+| 6-Gram KenLM**  | 1.10.0  | SentencePiece Unigram | 128           | 11.79%/3.35%           | 15.96%/6.39%       | 15.49%/6.25%      | 17.05%/5.43%         | 17.77%/6.23%         | 19.18%/7.1%          |
+*- Normalized and without special characters and punctuation.
+**- KenLM with 128 beam size with n_gram_alpha=1.0, n_gram_beta=1.0.
+## How to Use this Model
+- Can also be used from NGC, intrution [here](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/nemo/models/stt_hi_conformer_ctc_large).
+- Follow [colab](https://colab.research.google.com/drive/1mLWVCbe4JFnooDoQLG0_33Je0LXdCZjO?usp=sharing) to use it directly
+### 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.
+### Licence (Credit goes to Nvidia)
+License to use this model is covered by the [NGC TERMS OF USE](https://ngc.nvidia.com/legal/terms) unless another License/Terms Of Use/EULA is clearly specified. By downloading the public and release version of the model, you accept the terms and conditions of the [NGC TERMS OF USE](https://ngc.nvidia.com/legal/terms).