inference_code_snippet_added

README.md

@@ -43,15 +43,62 @@ should probably proofread and complete it, then remove this comment. -->
 This model is a fine-tuned version of [openai/whisper-medium](https://huggingface.co/openai/whisper-medium) on the Tamil data available from multiple publicly available ASR corpuses.
 It has been fine-tuned as a part of the Whisper fine-tuning sprint.
 
-## Training and evaluation data at Speech Lab, IITM
+**NOTE:** The code used to train this model is available for re-use in the [whisper-finetune](https://github.com/vasistalodagala/whisper-finetune) repository.
 
-Training Data: MILE ASR Corpus, ULCA ASR Corpus, Shrutilipi ASR Corpus, Microsoft Research Tamil Corpus (Train+Dev), Babel ASR Corpus, Google/Fleurs (Train+Dev) set.
+## Usage
 
-Evaluation Data: MILE ASR Corpus Test, Babel Test, Microsoft Research Tamil Corpus Test, Google/Fleurs Test set.
+In order to evaluate this model on an entire dataset, the evaluation codes available in the [whisper-finetune](https://github.com/vasistalodagala/whisper-finetune) repository can be used.
 
-## Training procedure
+The same repository also provides the scripts for faster inference using whisper-jax.
 
-### Training hyperparameters
+In order to infer a single audio file using this model, the following code snippet can be used:
+
+```python
+>>> import torch
+>>> from transformers import pipeline
+
+>>> # path to the audio file to be transcribed
+>>> audio = "/path/to/audio.format"
+>>> device = "cuda:0" if torch.cuda.is_available() else "cpu"
+
+>>> transcribe = pipeline(task="automatic-speech-recognition", model="vasista22/whisper-tamil-medium", chunk_length_s=30, device=device)
+>>> transcribe.model.config.forced_decoder_ids = transcribe.tokenizer.get_decoder_prompt_ids(language="ta", task="transcribe")
+
+>>> print('Transcription: ', transcribe(audio)["text"])
+```
+
+For faster inference of whisper models, the [whisper-jax](https://github.com/sanchit-gandhi/whisper-jax) library can be used. Please follow the necessary installation steps as mentioned [here](https://github.com/vasistalodagala/whisper-finetune#faster-evaluation-with-whisper-jax), before using the following code snippet:
+
+```python
+>>> import jax.numpy as jnp
+>>> from whisper_jax import FlaxWhisperForConditionalGeneration, FlaxWhisperPipline
+
+>>> # path to the audio file to be transcribed
+>>> audio = "/path/to/audio.format"
+
+>>> transcribe = FlaxWhisperPipline("vasista22/whisper-tamil-medium", batch_size=16)
+>>> transcribe.model.config.forced_decoder_ids = transcribe.tokenizer.get_decoder_prompt_ids(language="ta", task="transcribe")
+
+>>> print('Transcription: ', transcribe(audio)["text"])
+```
+
+## Training and evaluation data
+
+Training Data: 
+  - [IISc-MILE Tamil ASR Corpus](https://www.openslr.org/127/)
+  - [ULCA ASR Corpus](https://github.com/Open-Speech-EkStep/ULCA-asr-dataset-corpus#tamil-labelled--total-duration-is-116024-hours)
+  - [Shrutilipi ASR Corpus](https://ai4bharat.org/shrutilipi)
+  - [Microsoft Speech Corpus (Indian Languages)](https://msropendata.com/datasets/7230b4b1-912d-400e-be58-f84e0512985e)
+  - [Google/Fleurs Train+Dev set](https://huggingface.co/datasets/google/fleurs)
+  - Babel ASR Corpus
+
+Evaluation Data: 
+  - [Microsoft Speech Corpus (Indian Languages) Test Set](https://msropendata.com/datasets/7230b4b1-912d-400e-be58-f84e0512985e)
+  - [Google/Fleurs Test Set](https://huggingface.co/datasets/google/fleurs)
+  - [IISc-MILE Test Set](https://www.openslr.org/127/)
+  - Babel Test Set
+
+## Training hyperparameters
 
 The following hyperparameters were used during training:
 - learning_rate: 1e-05
@@ -65,4 +112,6 @@ The following hyperparameters were used during training:
 - mixed_precision_training: True
 
 ## Acknowledgement
-This work was done at Speech Lab, IITM. The compute resources for this work were funded by "Bhashini: National Language translation Mission" project of the Ministry of Electronics and Information Technology (MeitY), Government of India.
+This work was done at [Speech Lab, IIT Madras](https://asr.iitm.ac.in/).
+
+The compute resources for this work were funded by "Bhashini: National Language translation Mission" project of the Ministry of Electronics and Information Technology (MeitY), Government of India.