update README.md

README.md

@@ -1,36 +1,48 @@
 ---
 language:
 - fr
+license: apache-2.0
 tags:
 - automatic-speech-recognition
 - mozilla-foundation/common_voice_8_0
 - generated_from_trainer
+- robust-speech-event
 model-index:
-- name: ''
-  results: []
+- name: XLS-R-1B - French
+  results:
+  - task: 
+      name: Automatic Speech Recognition 
+      type: automatic-speech-recognition
+    dataset:
+      name: Common Voice 8
+      type: mozilla-foundation/common_voice_8_0
+      args: fr
+    metrics:
+       - name: Test WER
+         type: wer
+         value: 18.33
+       - name: Test CER
+         type: cer
+         value: 5.60
+  - task:
+      name: Automatic Speech Recognition
+      type: automatic-speech-recognition
+    dataset:
+      name: Robust Speech Event - Dev Data
+      type: speech-recognition-community-v2/dev_data
+      args: fr
+    metrics:
+       - name: Test WER
+         type: wer
+         value: 60.25
+       - name: Test CER
+         type: cer
+         value: 15.68
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
-# 
-
-This model is a fine-tuned version of [./checkpoint-13000](https://huggingface.co/./checkpoint-13000) on the MOZILLA-FOUNDATION/COMMON_VOICE_8_0 - FR dataset.
-It achieves the following results on the evaluation set:
-- Loss: inf
-- Wer: 0.2937
-
 ## Model description
 
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
+This model is a fine-tuned version of [facebook/wav2vec2-xls-r-1b](https://huggingface.co/facebook/wav2vec2-xls-r-1b) on the MOZILLA-FOUNDATION/COMMON_VOICE_8_0 - FR dataset.
 
 ## Training procedure
 
@@ -74,6 +86,10 @@ The following hyperparameters were used during training:
 | 0.8022        | 5.45  | 19000 | inf             | 0.1895 |
 | 0.792         | 5.73  | 20000 | inf             | 0.1854 |
 
+It achieves the best result on the validation set on STEP 13000:
+- Wer: 0.1834
+
+Some problem occurs when calculating the validation loss.
 
 ### Framework versions
 
@@ -81,3 +97,13 @@ The following hyperparameters were used during training:
 - Pytorch 1.10.2+cu102
 - Datasets 1.18.3.dev0
 - Tokenizers 0.11.0
+
+### Evaluation Commands
+1. To evaluate on `mozilla-foundation/common_voice_8` with split `test`
+```bash
+python eval.py --model_id Plim/xls-r-1b-cv_8-fr --dataset mozilla-foundation/common_voice_8_0 --config fr --split test
+```
+2. To evaluate on `speech-recognition-community-v2/dev_data`
+```bash
+python eval.py --model_id Plim/xls-r-1b-cv_8-fr --dataset speech-recognition-community-v2/dev_data --config fr --split validation --chunk_length_s 5.0 --stride_length_s 1.0
+```