Badr Abdullah commited on
Commit
c4e91d5
1 Parent(s): c815d3e

Model save

Browse files
Files changed (1) hide show
  1. README.md +108 -196
README.md CHANGED
@@ -1,199 +1,111 @@
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: xls-r-300m-hbs-ar-unfrozen-batch16
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: hsb
20
+ split: test
21
+ args: hsb
22
+ metrics:
23
+ - name: Wer
24
+ type: wer
25
+ value: 0.46954076850984067
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/runs/tkr20gft)
32
+ # xls-r-300m-hbs-ar-unfrozen-batch16
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.7763
37
+ - Wer: 0.4695
38
+ - Cer: 0.1093
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: 100
67
+ - mixed_precision_training: Native AMP
68
+
69
+ ### Training results
70
+
71
+ | Training Loss | Epoch | Step | Validation Loss | Wer | Cer |
72
+ |:-------------:|:-------:|:----:|:---------------:|:------:|:------:|
73
+ | 3.3679 | 3.2258 | 100 | 3.2752 | 1.0 | 1.0 |
74
+ | 3.0469 | 6.4516 | 200 | 2.9638 | 1.0 | 0.9902 |
75
+ | 0.5512 | 9.6774 | 300 | 0.7542 | 0.7664 | 0.1947 |
76
+ | 0.3029 | 12.9032 | 400 | 0.6819 | 0.6432 | 0.1584 |
77
+ | 0.1903 | 16.1290 | 500 | 0.7312 | 0.6361 | 0.1572 |
78
+ | 0.1464 | 19.3548 | 600 | 0.7223 | 0.5916 | 0.1456 |
79
+ | 0.1205 | 22.5806 | 700 | 0.7566 | 0.5738 | 0.1416 |
80
+ | 0.091 | 25.8065 | 800 | 0.7472 | 0.5527 | 0.1308 |
81
+ | 0.0686 | 29.0323 | 900 | 0.7029 | 0.5452 | 0.1337 |
82
+ | 0.0598 | 32.2581 | 1000 | 0.7889 | 0.5464 | 0.1309 |
83
+ | 0.0607 | 35.4839 | 1100 | 0.8012 | 0.5672 | 0.1412 |
84
+ | 0.0557 | 38.7097 | 1200 | 0.7628 | 0.5302 | 0.1333 |
85
+ | 0.0421 | 41.9355 | 1300 | 0.7861 | 0.5258 | 0.1265 |
86
+ | 0.0532 | 45.1613 | 1400 | 0.7843 | 0.5314 | 0.1272 |
87
+ | 0.0298 | 48.3871 | 1500 | 0.7888 | 0.5279 | 0.1253 |
88
+ | 0.0543 | 51.6129 | 1600 | 0.7847 | 0.5295 | 0.1290 |
89
+ | 0.0404 | 54.8387 | 1700 | 0.7314 | 0.5246 | 0.1249 |
90
+ | 0.0522 | 58.0645 | 1800 | 0.7505 | 0.5134 | 0.1222 |
91
+ | 0.0275 | 61.2903 | 1900 | 0.7588 | 0.5082 | 0.1202 |
92
+ | 0.0786 | 64.5161 | 2000 | 0.7733 | 0.4930 | 0.1171 |
93
+ | 0.0439 | 67.7419 | 2100 | 0.7953 | 0.4977 | 0.1133 |
94
+ | 0.0418 | 70.9677 | 2200 | 0.7664 | 0.4897 | 0.1126 |
95
+ | 0.0399 | 74.1935 | 2300 | 0.7599 | 0.4845 | 0.1100 |
96
+ | 0.0211 | 77.4194 | 2400 | 0.7747 | 0.4763 | 0.1115 |
97
+ | 0.0225 | 80.6452 | 2500 | 0.7607 | 0.4702 | 0.1094 |
98
+ | 0.0446 | 83.8710 | 2600 | 0.7583 | 0.4768 | 0.1103 |
99
+ | 0.0236 | 87.0968 | 2700 | 0.7824 | 0.4754 | 0.1102 |
100
+ | 0.0267 | 90.3226 | 2800 | 0.7861 | 0.4726 | 0.1110 |
101
+ | 0.0255 | 93.5484 | 2900 | 0.7928 | 0.4712 | 0.1106 |
102
+ | 0.0254 | 96.7742 | 3000 | 0.7834 | 0.4684 | 0.1102 |
103
+ | 0.0137 | 100.0 | 3100 | 0.7763 | 0.4695 | 0.1093 |
104
+
105
+
106
+ ### Framework versions
107
+
108
+ - Transformers 4.42.0.dev0
109
+ - Pytorch 2.3.1+cu121
110
+ - Datasets 2.19.2
111
+ - Tokenizers 0.19.1