Update README.md

README.md

@@ -3,7 +3,7 @@ license: apache-2.0
 tags:
 - generated_from_trainer
 datasets:
-- common_voice_12_0
+- mozilla-foundation/common_voice_12_0
 metrics:
 - wer
 model-index:
@@ -16,12 +16,14 @@ model-index:
       name: common_voice_12_0
       type: common_voice_12_0
       config: fy-NL
-      split: validation
+      split: test
       args: fy-NL
     metrics:
     - name: Wer
       type: wer
-      value: 0.15977951760699363
+      value: 0.15990775235054105
+language:
+- fy
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -32,19 +34,19 @@ should probably proofread and complete it, then remove this comment. -->
 This model is a fine-tuned version of [facebook/wav2vec2-xls-r-1b](https://huggingface.co/facebook/wav2vec2-xls-r-1b) on the common_voice_12_0 dataset.
 It achieves the following results on the evaluation set:
 - Loss: 0.2634
-- Wer: 0.1598
+- WER: 0.1599
 
-## Model description
-
-More information needed
+This model was developed together with [golesheed](https://huggingface.co/golesheed) for the course "Speech Recognition II" of the "MSc Voice Technology" program at Rijksuniversiteit Groningen - Campus Fryslân.
 
 ## Intended uses & limitations
 
-More information needed
+Intended use is for recognizing Frisian speech.
+
+Limitations include not enough hyperparameter tuning, no LM rescoring, and using v12 of Common Voice instead of v13.
 
 ## Training and evaluation data
 
-More information needed
+Training and evaluation splits used are the ones offered by the Common Voice dataset.
 
 ## Training procedure
 
@@ -97,4 +99,4 @@ The following hyperparameters were used during training:
 - Transformers 4.27.3
 - Pytorch 2.0.0+cu117
 - Datasets 2.10.1
-- Tokenizers 0.13.2
+- Tokenizers 0.13.2