ksingla025's picture
Update README.md
916b96e verified
metadata
model-index:
  - name: ksingla025/stt_en_conformer_ctc_caware
    results:
      - task:
          type: automatic-speech-recognition
        dataset:
          name: Librispeech (clean)
          type: librispeech_asr
          config: other
          split: test
          args:
            language: en
        metrics:
          - type: wer
            value: 12.1
            name: WER

ASR+NL Cache-aware Model Overview

Recoganize begin and end of digit sequences and also transcribe

NVIDIA NeMo: Training

To train, fine-tune or play with the model you will need to install NVIDIA NeMo. We recommend you install it after you've installed latest Pytorch version.

pip install nemo_toolkit['all']

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 inference or for fine-tuning on another dataset.

Automatically instantiate the model

import nemo.collections.asr as nemo_asr
asr_model = nemo_asr.models.ASRModel.from_pretrained("ksingla025/stt_en_conformer_ctc_caware")

Transcribe and tag using Python

First, let's get a sample

wget https://www.dropbox.com/s/fmre0xkl3ism62e/audio.zip?dl=0
unzip audio.zip

Then simply do:

asr_model.transcribe(['audio/digits1.wav'])

Transcribing many audio files

python [NEMO_GIT_FOLDER]/examples/asr/transcribe_speech.py  pretrained_name="ksingla025/stt_en_conformer_ctc_caware"  audio_dir="<DIRECTORY CONTAINING AUDIO FILES>"

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

Training

<ADD INFORMATION ABOUT HOW THE MODEL WAS TRAINED - HOW MANY EPOCHS, AMOUNT OF COMPUTE ETC>

Datasets

<LIST THE NAME AND SPLITS OF DATASETS USED TO TRAIN THIS MODEL (ALONG WITH LANGUAGE AND ANY ADDITIONAL INFORMATION)>

Performance

<LIST THE SCORES OF THE MODEL - OR USE THE Hugging Face Evaluate LiBRARY TO UPLOAD METRICS>

Limitations

Eg: 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] NVIDIA NeMo Toolkit