zainulhakim
commited on
Commit
•
71e42a4
1
Parent(s):
e8a4828
240624-wav2vec2-ASR-Arab
Browse files- README.md +45 -180
- special_tokens_map.json +28 -4
- tokenizer_config.json +1 -0
- vocab.json +24 -24
README.md
CHANGED
@@ -1,199 +1,64 @@
|
|
1 |
---
|
2 |
-
|
3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4 |
---
|
5 |
|
6 |
-
|
|
|
7 |
|
8 |
-
|
9 |
|
|
|
|
|
|
|
|
|
10 |
|
|
|
11 |
|
12 |
-
|
13 |
|
14 |
-
|
15 |
|
16 |
-
|
17 |
|
18 |
-
|
19 |
|
20 |
-
|
21 |
-
- **Funded by [optional]:** [More Information Needed]
|
22 |
-
- **Shared by [optional]:** [More Information Needed]
|
23 |
-
- **Model type:** [More Information Needed]
|
24 |
-
- **Language(s) (NLP):** [More Information Needed]
|
25 |
-
- **License:** [More Information Needed]
|
26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
27 |
|
28 |
-
|
29 |
|
30 |
-
|
31 |
|
32 |
-
|
33 |
-
-
|
34 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
35 |
|
36 |
-
|
37 |
|
38 |
-
|
|
|
|
|
|
|
|
|
39 |
|
40 |
-
### Direct Use
|
41 |
|
42 |
-
|
43 |
|
44 |
-
|
45 |
-
|
46 |
-
|
47 |
-
|
48 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
49 |
-
|
50 |
-
[More Information Needed]
|
51 |
-
|
52 |
-
### Out-of-Scope Use
|
53 |
-
|
54 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
55 |
-
|
56 |
-
[More Information Needed]
|
57 |
-
|
58 |
-
## Bias, Risks, and Limitations
|
59 |
-
|
60 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
61 |
-
|
62 |
-
[More Information Needed]
|
63 |
-
|
64 |
-
### Recommendations
|
65 |
-
|
66 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
67 |
-
|
68 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
69 |
-
|
70 |
-
## How to Get Started with the Model
|
71 |
-
|
72 |
-
Use the code below to get started with the model.
|
73 |
-
|
74 |
-
[More Information Needed]
|
75 |
-
|
76 |
-
## Training Details
|
77 |
-
|
78 |
-
### Training Data
|
79 |
-
|
80 |
-
<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
|
81 |
-
|
82 |
-
[More Information Needed]
|
83 |
-
|
84 |
-
### Training Procedure
|
85 |
-
|
86 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
87 |
-
|
88 |
-
#### Preprocessing [optional]
|
89 |
-
|
90 |
-
[More Information Needed]
|
91 |
-
|
92 |
-
|
93 |
-
#### Training Hyperparameters
|
94 |
-
|
95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
96 |
-
|
97 |
-
#### Speeds, Sizes, Times [optional]
|
98 |
-
|
99 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
100 |
-
|
101 |
-
[More Information Needed]
|
102 |
-
|
103 |
-
## Evaluation
|
104 |
-
|
105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
106 |
-
|
107 |
-
### Testing Data, Factors & Metrics
|
108 |
-
|
109 |
-
#### Testing Data
|
110 |
-
|
111 |
-
<!-- This should link to a Dataset Card if possible. -->
|
112 |
-
|
113 |
-
[More Information Needed]
|
114 |
-
|
115 |
-
#### Factors
|
116 |
-
|
117 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
118 |
-
|
119 |
-
[More Information Needed]
|
120 |
-
|
121 |
-
#### Metrics
|
122 |
-
|
123 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
124 |
-
|
125 |
-
[More Information Needed]
|
126 |
-
|
127 |
-
### Results
|
128 |
-
|
129 |
-
[More Information Needed]
|
130 |
-
|
131 |
-
#### Summary
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
## Model Examination [optional]
|
136 |
-
|
137 |
-
<!-- Relevant interpretability work for the model goes here -->
|
138 |
-
|
139 |
-
[More Information Needed]
|
140 |
-
|
141 |
-
## Environmental Impact
|
142 |
-
|
143 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
144 |
-
|
145 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
146 |
-
|
147 |
-
- **Hardware Type:** [More Information Needed]
|
148 |
-
- **Hours used:** [More Information Needed]
|
149 |
-
- **Cloud Provider:** [More Information Needed]
|
150 |
-
- **Compute Region:** [More Information Needed]
|
151 |
-
- **Carbon Emitted:** [More Information Needed]
|
152 |
-
|
153 |
-
## Technical Specifications [optional]
|
154 |
-
|
155 |
-
### Model Architecture and Objective
|
156 |
-
|
157 |
-
[More Information Needed]
|
158 |
-
|
159 |
-
### Compute Infrastructure
|
160 |
-
|
161 |
-
[More Information Needed]
|
162 |
-
|
163 |
-
#### Hardware
|
164 |
-
|
165 |
-
[More Information Needed]
|
166 |
-
|
167 |
-
#### Software
|
168 |
-
|
169 |
-
[More Information Needed]
|
170 |
-
|
171 |
-
## Citation [optional]
|
172 |
-
|
173 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
174 |
-
|
175 |
-
**BibTeX:**
|
176 |
-
|
177 |
-
[More Information Needed]
|
178 |
-
|
179 |
-
**APA:**
|
180 |
-
|
181 |
-
[More Information Needed]
|
182 |
-
|
183 |
-
## Glossary [optional]
|
184 |
-
|
185 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
186 |
-
|
187 |
-
[More Information Needed]
|
188 |
-
|
189 |
-
## More Information [optional]
|
190 |
-
|
191 |
-
[More Information Needed]
|
192 |
-
|
193 |
-
## Model Card Authors [optional]
|
194 |
-
|
195 |
-
[More Information Needed]
|
196 |
-
|
197 |
-
## Model Card Contact
|
198 |
-
|
199 |
-
[More Information Needed]
|
|
|
1 |
---
|
2 |
+
license: apache-2.0
|
3 |
+
base_model: zainulhakim/240615-wav2vec2-ASR-Arabs
|
4 |
+
tags:
|
5 |
+
- generated_from_trainer
|
6 |
+
metrics:
|
7 |
+
- wer
|
8 |
+
model-index:
|
9 |
+
- name: 240624-wav2vec2-ASR-Arab
|
10 |
+
results: []
|
11 |
---
|
12 |
|
13 |
+
<!-- This model card has been generated automatically according to the information the Trainer had access to. You
|
14 |
+
should probably proofread and complete it, then remove this comment. -->
|
15 |
|
16 |
+
# 240624-wav2vec2-ASR-Arab
|
17 |
|
18 |
+
This model is a fine-tuned version of [zainulhakim/240615-wav2vec2-ASR-Arabs](https://huggingface.co/zainulhakim/240615-wav2vec2-ASR-Arabs) on an unknown dataset.
|
19 |
+
It achieves the following results on the evaluation set:
|
20 |
+
- Loss: 1.3847
|
21 |
+
- Wer: 0.9798
|
22 |
|
23 |
+
## Model description
|
24 |
|
25 |
+
More information needed
|
26 |
|
27 |
+
## Intended uses & limitations
|
28 |
|
29 |
+
More information needed
|
30 |
|
31 |
+
## Training and evaluation data
|
32 |
|
33 |
+
More information needed
|
|
|
|
|
|
|
|
|
|
|
|
|
34 |
|
35 |
+
## Training procedure
|
36 |
|
37 |
+
### Training hyperparameters
|
38 |
|
39 |
+
The following hyperparameters were used during training:
|
40 |
+
- learning_rate: 0.0001
|
41 |
+
- train_batch_size: 5
|
42 |
+
- eval_batch_size: 8
|
43 |
+
- seed: 42
|
44 |
+
- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
|
45 |
+
- lr_scheduler_type: linear
|
46 |
+
- lr_scheduler_warmup_steps: 500
|
47 |
+
- num_epochs: 20
|
48 |
+
- mixed_precision_training: Native AMP
|
49 |
|
50 |
+
### Training results
|
51 |
|
52 |
+
| Training Loss | Epoch | Step | Validation Loss | Wer |
|
53 |
+
|:-------------:|:-----:|:----:|:---------------:|:------:|
|
54 |
+
| No log | 6.25 | 100 | 2.5453 | 1.0 |
|
55 |
+
| No log | 12.5 | 200 | 1.9038 | 1.0 |
|
56 |
+
| No log | 18.75 | 300 | 1.3847 | 0.9798 |
|
57 |
|
|
|
58 |
|
59 |
+
### Framework versions
|
60 |
|
61 |
+
- Transformers 4.41.2
|
62 |
+
- Pytorch 2.3.1+cu121
|
63 |
+
- Datasets 2.19.2
|
64 |
+
- Tokenizers 0.19.1
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
special_tokens_map.json
CHANGED
@@ -1,6 +1,30 @@
|
|
1 |
{
|
2 |
-
"bos_token":
|
3 |
-
|
4 |
-
|
5 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
6 |
}
|
|
|
1 |
{
|
2 |
+
"bos_token": {
|
3 |
+
"content": "<s>",
|
4 |
+
"lstrip": false,
|
5 |
+
"normalized": false,
|
6 |
+
"rstrip": false,
|
7 |
+
"single_word": false
|
8 |
+
},
|
9 |
+
"eos_token": {
|
10 |
+
"content": "</s>",
|
11 |
+
"lstrip": false,
|
12 |
+
"normalized": false,
|
13 |
+
"rstrip": false,
|
14 |
+
"single_word": false
|
15 |
+
},
|
16 |
+
"pad_token": {
|
17 |
+
"content": "[PAD]",
|
18 |
+
"lstrip": true,
|
19 |
+
"normalized": false,
|
20 |
+
"rstrip": true,
|
21 |
+
"single_word": false
|
22 |
+
},
|
23 |
+
"unk_token": {
|
24 |
+
"content": "[UNK]",
|
25 |
+
"lstrip": true,
|
26 |
+
"normalized": false,
|
27 |
+
"rstrip": true,
|
28 |
+
"single_word": false
|
29 |
+
}
|
30 |
}
|
tokenizer_config.json
CHANGED
@@ -39,6 +39,7 @@
|
|
39 |
"eos_token": "</s>",
|
40 |
"model_max_length": 1000000000000000019884624838656,
|
41 |
"pad_token": "[PAD]",
|
|
|
42 |
"replace_word_delimiter_char": " ",
|
43 |
"target_lang": null,
|
44 |
"tokenizer_class": "Wav2Vec2CTCTokenizer",
|
|
|
39 |
"eos_token": "</s>",
|
40 |
"model_max_length": 1000000000000000019884624838656,
|
41 |
"pad_token": "[PAD]",
|
42 |
+
"processor_class": "Wav2Vec2Processor",
|
43 |
"replace_word_delimiter_char": " ",
|
44 |
"target_lang": null,
|
45 |
"tokenizer_class": "Wav2Vec2CTCTokenizer",
|
vocab.json
CHANGED
@@ -1,28 +1,28 @@
|
|
1 |
{
|
2 |
"[PAD]": 25,
|
3 |
"[UNK]": 24,
|
4 |
-
"a":
|
5 |
-
"b":
|
6 |
-
"c":
|
7 |
-
"d":
|
8 |
-
"e":
|
9 |
-
"f":
|
10 |
-
"g":
|
11 |
-
"h":
|
12 |
-
"i":
|
13 |
-
"k":
|
14 |
-
"l":
|
15 |
-
"m":
|
16 |
-
"n":
|
17 |
-
"o":
|
18 |
-
"p":
|
19 |
-
"r":
|
20 |
-
"s":
|
21 |
-
"t":
|
22 |
-
"u":
|
23 |
-
"v":
|
24 |
-
"w":
|
25 |
-
"x":
|
26 |
-
"y":
|
27 |
-
"|":
|
28 |
}
|
|
|
1 |
{
|
2 |
"[PAD]": 25,
|
3 |
"[UNK]": 24,
|
4 |
+
"a": 2,
|
5 |
+
"b": 15,
|
6 |
+
"c": 1,
|
7 |
+
"d": 9,
|
8 |
+
"e": 7,
|
9 |
+
"f": 8,
|
10 |
+
"g": 13,
|
11 |
+
"h": 17,
|
12 |
+
"i": 11,
|
13 |
+
"k": 16,
|
14 |
+
"l": 23,
|
15 |
+
"m": 3,
|
16 |
+
"n": 19,
|
17 |
+
"o": 5,
|
18 |
+
"p": 12,
|
19 |
+
"r": 18,
|
20 |
+
"s": 21,
|
21 |
+
"t": 20,
|
22 |
+
"u": 22,
|
23 |
+
"v": 4,
|
24 |
+
"w": 14,
|
25 |
+
"x": 0,
|
26 |
+
"y": 6,
|
27 |
+
"|": 10
|
28 |
}
|