Create README.md
Browse files
README.md
ADDED
@@ -0,0 +1,102 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
language:
|
3 |
+
- ky
|
4 |
+
license: apache-2.0
|
5 |
+
tags:
|
6 |
+
- automatic-speech-recognition
|
7 |
+
- mozilla-foundation/common_voice_8_0
|
8 |
+
- generated_from_trainer
|
9 |
+
- ky
|
10 |
+
- robust-speech-event
|
11 |
+
- model_for_talk
|
12 |
+
datasets:
|
13 |
+
- mozilla-foundation/common_voice_8_0
|
14 |
+
|
15 |
+
model-index:
|
16 |
+
- name: sammy786/wav2vec2-xlsr-kyrgyz
|
17 |
+
results:
|
18 |
+
- task:
|
19 |
+
name: Automatic Speech Recognition
|
20 |
+
type: automatic-speech-recognition
|
21 |
+
dataset:
|
22 |
+
name: Common Voice 8
|
23 |
+
type: mozilla-foundation/common_voice_8_0
|
24 |
+
args: ky
|
25 |
+
metrics:
|
26 |
+
- name: Test WER
|
27 |
+
type: wer
|
28 |
+
value: 25.24
|
29 |
+
- name: Test CER
|
30 |
+
type: cer
|
31 |
+
value: 6.25
|
32 |
+
---
|
33 |
+
# sammy786/wav2vec2-xlsr-kyrgyz
|
34 |
+
|
35 |
+
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 - ky dataset.
|
36 |
+
It achieves the following results on evaluation set (which is 10 percent of train data set merged with other and dev datasets):
|
37 |
+
- Loss: 43.06
|
38 |
+
- Wer: 39.19
|
39 |
+
|
40 |
+
## Model description
|
41 |
+
"facebook/wav2vec2-xls-r-1b" was finetuned.
|
42 |
+
|
43 |
+
## Intended uses & limitations
|
44 |
+
More information needed
|
45 |
+
## Training and evaluation data
|
46 |
+
Training data -
|
47 |
+
Common voice Finnish train.tsv, dev.tsv and other.tsv
|
48 |
+
|
49 |
+
## Training procedure
|
50 |
+
For creating the train dataset, all possible datasets were appended and 90-10 split was used.
|
51 |
+
|
52 |
+
### Training hyperparameters
|
53 |
+
|
54 |
+
The following hyperparameters were used during training:
|
55 |
+
|
56 |
+
- learning_rate: 0.000045637994662983496
|
57 |
+
- train_batch_size: 8
|
58 |
+
- eval_batch_size: 16
|
59 |
+
- seed: 13
|
60 |
+
- gradient_accumulation_steps: 2
|
61 |
+
- total_train_batch_size: 32
|
62 |
+
- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
|
63 |
+
- lr_scheduler_type: cosine_with_restarts
|
64 |
+
- lr_scheduler_warmup_steps: 500
|
65 |
+
- num_epochs: 30
|
66 |
+
- mixed_precision_training: Native AMP
|
67 |
+
|
68 |
+
|
69 |
+
### Training results
|
70 |
+
|
71 |
+
|
72 |
+
| Step | Training Loss | Validation Loss | Wer |
|
73 |
+
|------|---------------|-----------------|----------|
|
74 |
+
| 200 | 5.357800 | 2.700367 | 1.000000 |
|
75 |
+
| 400 | 1.513600 | 0.642542 | 0.598820 |
|
76 |
+
| 600 | 0.961900 | 0.530665 | 0.502739 |
|
77 |
+
| 800 | 0.776000 | 0.507709 | 0.462705 |
|
78 |
+
| 1000 | 0.646100 | 0.453115 | 0.444164 |
|
79 |
+
| 1200 | 0.581200 | 0.454797 | 0.438264 |
|
80 |
+
| 1400 | 0.437900 | 0.459389 | 0.426464 |
|
81 |
+
| 1600 | 0.348600 | 0.401247 | 0.416351 |
|
82 |
+
| 1800 | 0.312800 | 0.436135 | 0.409608 |
|
83 |
+
| 2000 | 0.294100 | 0.440911 | 0.398651 |
|
84 |
+
| 2200 | 0.281400 | 0.432729 | 0.394016 |
|
85 |
+
| 2400 | 0.258400 | 0.429860 | 0.393595 |
|
86 |
+
| 2600 | 0.263700 | 0.432689 | 0.395280 |
|
87 |
+
| 2800 | 0.256900 | 0.430672 | 0.391909 |
|
88 |
+
|
89 |
+
|
90 |
+
### Framework versions
|
91 |
+
- Transformers 4.16.0.dev0
|
92 |
+
- Pytorch 1.10.0+cu102
|
93 |
+
- Datasets 1.17.1.dev0
|
94 |
+
- Tokenizers 0.10.3
|
95 |
+
|
96 |
+
#### Evaluation Commands
|
97 |
+
|
98 |
+
1. To evaluate on `mozilla-foundation/common_voice_8_0` with split `test`
|
99 |
+
|
100 |
+
```bash
|
101 |
+
python eval.py --model_id sammy786/wav2vec2-xlsr-kyrgyz --dataset mozilla-foundation/common_voice_8_0 --config ky --split test
|
102 |
+
```
|