Update README.md

README.md

@@ -20,18 +20,6 @@ should probably proofread and complete it, then remove this comment. -->
 
 This model is a fine-tuned version of [openai/whisper-base](https://huggingface.co/openai/whisper-base) on the Common Voice 17.0 dataset.
 
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
 ## Training procedure
 
 ### Training hyperparameters
@@ -47,9 +35,39 @@ The following hyperparameters were used during training:
 - training_steps: 4000
 - mixed_precision_training: Native AMP
 
-### Training results
+### test results
+
+- Best test WER (Word Error Rate): 0.547
+- Best test CER (Character Error Rate): 0.227
+
+### Usage
+```python
+import torch
+from transformers import AutoModelForSpeechSeq2Seq, AutoProcessor, pipeline
+
+device = "cuda:0" if torch.cuda.is_available() else "cpu"
+torch_dtype = torch.float16 if torch.cuda.is_available() else torch.float32
+
+model_id = "aictsharif/whisper-base-fa"
+model = AutoModelForSpeechSeq2Seq.from_pretrained(
+    model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True, use_safetensors=True
+)
+model.to(device)
+
+processor = AutoProcessor.from_pretrained(model_id)
+pipe = pipeline(
+    "automatic-speech-recognition",
+    model=model,
+    tokenizer=processor.tokenizer,
+    feature_extractor=processor.feature_extractor,
+    torch_dtype=torch_dtype,
+    device=device,
+)
 
+result = pipe('sample.mp3')
+print(result["text"])
 
+```
 
 ### Framework versions