Update README.md

README.md

@@ -1,6 +1,29 @@
 ---
-library_name: transformers
-tags: []
+language:
+- ar
+license: apache-2.0
+base_model: openai/whisper-small
+tags:
+- generated_from_trainer
+metrics:
+- wer
+model-index:
+- name: Tunisian Checkpoint1.5
+  results:
+  - task:
+      name: Automatic Speech Recognition
+      type: automatic-speech-recognition
+    dataset:
+      name: custom_tunisian_dataset
+      type: dataset
+      args: 'config: ar, split: test'
+    metrics:
+    - name: Wer
+      type: wer
+      value:  51.80948419301165
+    - name: Cer
+      type: cer
+      value:  25.522807875749052
 ---
 
 # Model Card for Model ID
@@ -9,21 +32,29 @@ tags: []
 
 
 
+### Finetuning Whisper on Tunisian custom dataset
+
 ## Model Details
 
 ### Model Description
 
 <!-- Provide a longer summary of what this model is. -->
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+This model is a fine-tuned version of [openai/whisper-small](https://huggingface.co/openai/whisper-small) on the tunisian_custom dataset (2h and 30mn).
+It achieves the following results on the evaluation set:
+- Train Loss: 0.0029
+- Evaluation Loss:  1.1970311403274536
+- Wer:  51.80948419301165
+- Cer:  25.522807875749052
+  
 
-- **Developed by:** [More Information Needed]
+- **Developed by:** [Ameni Khabthani]
 - **Funded by [optional]:** [More Information Needed]
 - **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
+- **Model type:** [ASR system]
 - **Language(s) (NLP):** [More Information Needed]
 - **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Finetuned from model [optional]:** [whisper small]
 
 ### Model Sources [optional]
 
@@ -33,45 +64,6 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 - **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
 
@@ -92,6 +84,23 @@ Use the code below to get started with the model.
 
 #### Training Hyperparameters
 
+per_device_train_batch_size=8          
+gradient_accumulation_steps=8        
+learning_rate=  5e-5                    
+warmup_steps=100                      
+max_steps=3000                       
+gradient_checkpointing=True           
+fp16=True      
+save_steps=500                        
+eval_steps=500                        
+per_device_eval_batch_size=8          
+predict_with_generate=True             
+generation_max_length=225             
+logging_steps=50,                       
+optim="adamw_bnb_8bit"               
+weight_decay=0.01
+dropout=0.1
+
 - **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]