lucio commited on
Commit
7b31889
1 Parent(s): f3d6d17

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +30 -6
README.md CHANGED
@@ -6,11 +6,27 @@ tags:
6
  - automatic-speech-recognition
7
  - mozilla-foundation/common_voice_8_0
8
  - generated_from_trainer
 
 
9
  datasets:
10
- - common_voice
11
  model-index:
12
- - name: xls-r-uyghur-cv8
13
- results: []
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  ---
15
 
16
  <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -25,18 +41,26 @@ It achieves the following results on the evaluation set:
25
 
26
  ## Model description
27
 
28
- More information needed
 
 
29
 
30
  ## Intended uses & limitations
31
 
32
- More information needed
 
 
 
 
33
 
34
  ## Training and evaluation data
35
 
36
- More information needed
37
 
38
  ## Training procedure
39
 
 
 
40
  ### Training hyperparameters
41
 
42
  The following hyperparameters were used during training:
 
6
  - automatic-speech-recognition
7
  - mozilla-foundation/common_voice_8_0
8
  - generated_from_trainer
9
+ - ug
10
+ - robust-speech-event
11
  datasets:
12
+ - - mozilla-foundation/common_voice_8_0
13
  model-index:
14
+ - name: XLS-R-300M Uyghur CV8
15
+ results:
16
+ - task:
17
+ name: Automatic Speech Recognition
18
+ type: automatic-speech-recognition
19
+ dataset:
20
+ name: Common Voice 8
21
+ type: mozilla-foundation/common_voice_8_0
22
+ args: ug
23
+ metrics:
24
+ - name: Test WER
25
+ type: wer
26
+ value: 30.50
27
+ - name: Test CER
28
+ type: cer
29
+ value: 5.80
30
  ---
31
 
32
  <!-- This model card has been generated automatically according to the information the Trainer had access to. You
 
41
 
42
  ## Model description
43
 
44
+ For a description of the model architecture, see [facebook/wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m)
45
+
46
+ The model vocabulary consists of the alphabetic characters of the [Perso-Arabic script for the Uyghur language](https://omniglot.com/writing/uyghur.htm), with punctuation removed.
47
 
48
  ## Intended uses & limitations
49
 
50
+ This model is expected to be of some utility for low-fidelity use cases such as:
51
+ - Draft video captions
52
+ - Indexing of recorded broadcasts
53
+
54
+ 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.
55
 
56
  ## Training and evaluation data
57
 
58
+ 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.
59
 
60
  ## Training procedure
61
 
62
+ 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 9400 steps (100 epochs).
63
+
64
  ### Training hyperparameters
65
 
66
  The following hyperparameters were used during training: