Badr Abdullah commited on
Commit
e18be69
1 Parent(s): 8e2b67f

Model save

Browse files
Files changed (1) hide show
  1. README.md +103 -196
README.md CHANGED
@@ -1,199 +1,106 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
-
11
-
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
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
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
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: facebook/wav2vec2-xls-r-300m
4
+ tags:
5
+ - generated_from_trainer
6
+ datasets:
7
+ - common_voice_17_0
8
+ metrics:
9
+ - wer
10
+ model-index:
11
+ - name: xlsr-mk
12
+ results:
13
+ - task:
14
+ name: Automatic Speech Recognition
15
+ type: automatic-speech-recognition
16
+ dataset:
17
+ name: common_voice_17_0
18
+ type: common_voice_17_0
19
+ config: mk
20
+ split: validation
21
+ args: mk
22
+ metrics:
23
+ - name: Wer
24
+ type: wer
25
+ value: 0.4437212531458821
26
  ---
27
 
28
+ <!-- This model card has been generated automatically according to the information the Trainer had access to. You
29
+ should probably proofread and complete it, then remove this comment. -->
30
+
31
+ [<img src="https://raw.githubusercontent.com/wandb/assets/main/wandb-github-badge-28.svg" alt="Visualize in Weights & Biases" width="200" height="32"/>](https://wandb.ai/badr-nlp/xlsr-continual-finetuning-hebrew/runs/dehxs1oz)
32
+ # xlsr-mk
33
+
34
+ This model is a fine-tuned version of [facebook/wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m) on the common_voice_17_0 dataset.
35
+ It achieves the following results on the evaluation set:
36
+ - Loss: 0.6273
37
+ - Wer: 0.4437
38
+ - Cer: 0.1074
39
+
40
+ ## Model description
41
+
42
+ More information needed
43
+
44
+ ## Intended uses & limitations
45
+
46
+ More information needed
47
+
48
+ ## Training and evaluation data
49
+
50
+ More information needed
51
+
52
+ ## Training procedure
53
+
54
+ ### Training hyperparameters
55
+
56
+ The following hyperparameters were used during training:
57
+ - learning_rate: 0.0003
58
+ - train_batch_size: 16
59
+ - eval_batch_size: 8
60
+ - seed: 42
61
+ - gradient_accumulation_steps: 2
62
+ - total_train_batch_size: 32
63
+ - optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
64
+ - lr_scheduler_type: linear
65
+ - lr_scheduler_warmup_steps: 500
66
+ - num_epochs: 50
67
+ - mixed_precision_training: Native AMP
68
+
69
+ ### Training results
70
+
71
+ | Training Loss | Epoch | Step | Validation Loss | Wer | Cer |
72
+ |:-------------:|:-------:|:----:|:---------------:|:------:|:------:|
73
+ | 3.541 | 1.8868 | 100 | 3.5532 | 1.0 | 1.0 |
74
+ | 2.966 | 3.7736 | 200 | 2.9438 | 1.0 | 1.0 |
75
+ | 2.298 | 5.6604 | 300 | 2.1673 | 1.0 | 0.7080 |
76
+ | 0.5999 | 7.5472 | 400 | 0.7521 | 0.7476 | 0.2035 |
77
+ | 0.3941 | 9.4340 | 500 | 0.7249 | 0.6911 | 0.1845 |
78
+ | 0.2226 | 11.3208 | 600 | 0.6970 | 0.6602 | 0.1725 |
79
+ | 0.3031 | 13.2075 | 700 | 0.7692 | 0.6506 | 0.1680 |
80
+ | 0.1621 | 15.0943 | 800 | 0.7229 | 0.6232 | 0.1583 |
81
+ | 0.2052 | 16.9811 | 900 | 0.6990 | 0.5722 | 0.1471 |
82
+ | 0.1441 | 18.8679 | 1000 | 0.6829 | 0.5591 | 0.1400 |
83
+ | 0.0548 | 20.7547 | 1100 | 0.6560 | 0.5309 | 0.1333 |
84
+ | 0.1312 | 22.6415 | 1200 | 0.6590 | 0.5375 | 0.1332 |
85
+ | 0.0582 | 24.5283 | 1300 | 0.7023 | 0.5268 | 0.1321 |
86
+ | 0.1163 | 26.4151 | 1400 | 0.6900 | 0.5170 | 0.1293 |
87
+ | 0.0491 | 28.3019 | 1500 | 0.6499 | 0.5089 | 0.1274 |
88
+ | 0.063 | 30.1887 | 1600 | 0.6478 | 0.4869 | 0.1221 |
89
+ | 0.0735 | 32.0755 | 1700 | 0.6678 | 0.4967 | 0.1256 |
90
+ | 0.0437 | 33.9623 | 1800 | 0.6651 | 0.4803 | 0.1188 |
91
+ | 0.0514 | 35.8491 | 1900 | 0.6741 | 0.4724 | 0.1168 |
92
+ | 0.0306 | 37.7358 | 2000 | 0.6564 | 0.4717 | 0.1168 |
93
+ | 0.0458 | 39.6226 | 2100 | 0.6428 | 0.4679 | 0.1140 |
94
+ | 0.0398 | 41.5094 | 2200 | 0.6385 | 0.4531 | 0.1103 |
95
+ | 0.0574 | 43.3962 | 2300 | 0.5991 | 0.4392 | 0.1063 |
96
+ | 0.0481 | 45.2830 | 2400 | 0.6394 | 0.4468 | 0.1087 |
97
+ | 0.0376 | 47.1698 | 2500 | 0.6184 | 0.4434 | 0.1072 |
98
+ | 0.0275 | 49.0566 | 2600 | 0.6273 | 0.4437 | 0.1074 |
99
+
100
+
101
+ ### Framework versions
102
+
103
+ - Transformers 4.42.0.dev0
104
+ - Pytorch 2.3.1+cu121
105
+ - Datasets 2.19.2
106
+ - Tokenizers 0.19.1