add readme description

README.md

@@ -1,10 +1,35 @@
 ---
+language:
+- ne
 license: apache-2.0
 tags:
 - generated_from_trainer
+- automatic-speech-recognition
+- speech
+- openslr
+- nepali
+datasets:
+- spktsagar/openslr-nepali-asr-cleaned
+metrics:
+- wer
 model-index:
 - name: wav2vec2-large-xls-r-300m-nepali-openslr
-  results: []
+  results:
+  - task:
+      type: automatic-speech-recognition
+      name: Nepali Speech Recognition
+    dataset:
+      type: spktsagar/openslr-nepali-asr-cleaned
+      name: OpenSLR Nepali ASR
+      config: original
+      split: train
+    metrics:
+      - type: were
+        value: 21.27
+        name: Test WER
+        verified: false
+    
+   
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -12,7 +37,7 @@ should probably proofread and complete it, then remove this comment. -->
 
 # wav2vec2-large-xls-r-300m-nepali-openslr
 
-This model is a fine-tuned version of [facebook/wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m) on an unknown dataset.
+This model is a fine-tuned version of [facebook/wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m) on an [OpenSLR Nepali ASR](https://huggingface.co/datasets/spktsagar/openslr-nepali-asr-cleaned) dataset.
 It achieves the following results on the evaluation set:
 - eval_loss: 0.1767
 - eval_wer: 0.2127
@@ -24,17 +49,30 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+Wav2Vec2 is a pretrained model for Automatic Speech Recognition (ASR) and was released in September 2020 by Alexei Baevski, Michael Auli, and Alex Conneau. Soon after the superior performance of Wav2Vec2 was demonstrated on one of the most popular English datasets for ASR, called LibriSpeech, Facebook AI presented a multi-lingual version of Wav2Vec2, called XLSR. XLSR stands for cross-lingual speech representations and refers to model's ability to learn speech representations that are useful across multiple languages.
 
-## Intended uses & limitations
+## How to use?
+1. Install transformers and librosa
+```
+pip install librosa, transformers
+```
+2. Run the following code which loads your audio file, preprocessor, models, and returns your prediction
+```python
+import librosa
+from transformers import pipeline
+
+audio, sample_rate = librosa.load("<path to your audio file>", sr=16000)
+recognizer = pipeline("automatic-speech-recognition", model="spktsagar/wav2vec2-large-xls-r-300m-nepali-openslr")
+prediction = recognizer(audio)
+```
 
-More information needed
+## Intended uses & limitations
 
-## Training and evaluation data
+The model is trained on the OpenSLR Nepali ASR dataset, which in itself has some incorrect transcriptions, so it is obvious that the model will not have perfect predictions for your transcript. Similarly, due to colab's resource limit utterances longer than 5 sec are filtered out from the dataset during training and evaluation. Hence, the model might not perform as expected when given audio input longer than 5 sec.
 
-More information needed
+## Training and evaluation data and Training procedure
 
-## Training procedure
+For dataset preparation and training code, please consult [my blog](https://sagar-spkt.github.io/posts/2022/08/finetune-xlsr-nepali/).
 
 ### Training hyperparameters