Update README.md

README.md

@@ -6,37 +6,60 @@ tags:
 - automatic-speech-recognition
 - mozilla-foundation/common_voice_8_0
 - generated_from_trainer
+- ug
 datasets:
-- common_voice
+- mozilla-foundation/common_voice_8_0
 model-index:
-- name: xls-r-uyghur-cv8
-  results: []
+- name: XLS-R-300M Uyghur CV8
+  results:
+  - task: 
+      name: Automatic Speech Recognition 
+      type: automatic-speech-recognition
+    dataset:
+      name: Common Voice 8
+      type: mozilla-foundation/common_voice_8_0
+      args: ug
+    metrics:
+       - name: Test WER
+         type: wer
+         value: 28.74
+       - name: Test CER
+         type: cer
+         value: 5.38
 ---
 
 <!-- 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. -->
 
-# xls-r-uyghur-cv8
+# XLS-R-300M Uyghur CV8
 
 This model is a fine-tuned version of [facebook/wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m) on the MOZILLA-FOUNDATION/COMMON_VOICE_8_0 - UG dataset.
 It achieves the following results on the evaluation set:
 - Loss: 0.2036
-- Wer: 0.2977
+- WER: 0.2977
 
 ## Model description
 
-More information needed
+For a description of the model architecture, see [facebook/wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m)
+
+The model vocabulary consists of the alphabetic characters of the [Perso-Arabic script conventionally used for the Uyghur language](https://omniglot.com/writing/uyghur.htm), with punctuation removed.
 
 ## Intended uses & limitations
 
-More information needed
+This model is expected to be of some utility for low-fidelity use cases such as:
+- Draft video captions
+- Indexing of recorded broadcasts
+
+The model is not reliable enough to use as a substitute for live captions for accessibility purposes, and it should not be used in a manner that would infringe the privacy of any of the contributors to the Common Voice dataset nor any other speakers.
 
 ## Training and evaluation data
 
-More information needed
+The combination of `train` and `dev` of common voice official splits were used as training data. The official `test` split was used as validation data as well as for final evaluation.
 
 ## Training procedure
 
+The featurization layers of the XLS-R model are frozen while tuning a final CTC/LM layer on the Uyghur CV8 example sentences. A ramped learning rate is used with an initial warmup phase of 2000 steps, a max of 0.0001, and cooling back towards 0 for the remainder of the 18500 steps (100 epochs).
+
 ### Training hyperparameters
 
 The following hyperparameters were used during training: