abduaziz commited on
Commit
302b45b
1 Parent(s): 9c85d3a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +67 -178
README.md CHANGED
@@ -1,201 +1,90 @@
1
  ---
2
  library_name: transformers
 
 
 
 
3
  tags:
 
4
  - automatic-speech-recognition
5
  - whisper
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  ---
7
 
8
- # Model Card for Model ID
 
9
 
10
- <!-- Provide a quick summary of what the model is/does. -->
11
 
 
 
 
 
12
 
 
13
 
14
- ## Model Details
15
 
16
- ### Model Description
17
 
18
- <!-- Provide a longer summary of what this model is. -->
19
 
20
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
21
 
22
- - **Developed by:** [More Information Needed]
23
- - **Funded by [optional]:** [More Information Needed]
24
- - **Shared by [optional]:** [More Information Needed]
25
- - **Model type:** [More Information Needed]
26
- - **Language(s) (NLP):** [More Information Needed]
27
- - **License:** [More Information Needed]
28
- - **Finetuned from model [optional]:** [More Information Needed]
29
 
30
- ### Model Sources [optional]
31
 
32
- <!-- Provide the basic links for the model. -->
33
 
34
- - **Repository:** [More Information Needed]
35
- - **Paper [optional]:** [More Information Needed]
36
- - **Demo [optional]:** [More Information Needed]
 
 
 
 
 
 
 
37
 
38
- ## Uses
39
 
40
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
 
 
 
 
 
 
 
 
 
 
 
41
 
42
- ### Direct Use
43
 
44
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
45
 
46
- [More Information Needed]
47
-
48
- ### Downstream Use [optional]
49
-
50
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
51
-
52
- [More Information Needed]
53
-
54
- ### Out-of-Scope Use
55
-
56
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
57
-
58
- [More Information Needed]
59
-
60
- ## Bias, Risks, and Limitations
61
-
62
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
63
-
64
- [More Information Needed]
65
-
66
- ### Recommendations
67
-
68
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
69
-
70
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
71
-
72
- ## How to Get Started with the Model
73
-
74
- Use the code below to get started with the model.
75
-
76
- [More Information Needed]
77
-
78
- ## Training Details
79
-
80
- ### Training Data
81
-
82
- <!-- 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. -->
83
-
84
- [More Information Needed]
85
-
86
- ### Training Procedure
87
-
88
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
89
-
90
- #### Preprocessing [optional]
91
-
92
- [More Information Needed]
93
-
94
-
95
- #### Training Hyperparameters
96
-
97
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
98
-
99
- #### Speeds, Sizes, Times [optional]
100
-
101
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
102
-
103
- [More Information Needed]
104
-
105
- ## Evaluation
106
-
107
- <!-- This section describes the evaluation protocols and provides the results. -->
108
-
109
- ### Testing Data, Factors & Metrics
110
-
111
- #### Testing Data
112
-
113
- <!-- This should link to a Dataset Card if possible. -->
114
-
115
- [More Information Needed]
116
-
117
- #### Factors
118
-
119
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
120
-
121
- [More Information Needed]
122
-
123
- #### Metrics
124
-
125
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
126
-
127
- [More Information Needed]
128
-
129
- ### Results
130
-
131
- [More Information Needed]
132
-
133
- #### Summary
134
-
135
-
136
-
137
- ## Model Examination [optional]
138
-
139
- <!-- Relevant interpretability work for the model goes here -->
140
-
141
- [More Information Needed]
142
-
143
- ## Environmental Impact
144
-
145
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
146
-
147
- 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).
148
-
149
- - **Hardware Type:** [More Information Needed]
150
- - **Hours used:** [More Information Needed]
151
- - **Cloud Provider:** [More Information Needed]
152
- - **Compute Region:** [More Information Needed]
153
- - **Carbon Emitted:** [More Information Needed]
154
-
155
- ## Technical Specifications [optional]
156
-
157
- ### Model Architecture and Objective
158
-
159
- [More Information Needed]
160
-
161
- ### Compute Infrastructure
162
-
163
- [More Information Needed]
164
-
165
- #### Hardware
166
-
167
- [More Information Needed]
168
-
169
- #### Software
170
-
171
- [More Information Needed]
172
-
173
- ## Citation [optional]
174
-
175
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
176
-
177
- **BibTeX:**
178
-
179
- [More Information Needed]
180
-
181
- **APA:**
182
-
183
- [More Information Needed]
184
-
185
- ## Glossary [optional]
186
-
187
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
188
-
189
- [More Information Needed]
190
-
191
- ## More Information [optional]
192
-
193
- [More Information Needed]
194
-
195
- ## Model Card Authors [optional]
196
-
197
- [More Information Needed]
198
-
199
- ## Model Card Contact
200
-
201
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
+ language:
4
+ - uz
5
+ license: apache-2.0
6
+ base_model: openai/whisper-small
7
  tags:
8
+ - generated_from_trainer
9
  - automatic-speech-recognition
10
  - whisper
11
+ datasets:
12
+ - mozilla-foundation/common_voice_17_0
13
+ metrics:
14
+ - wer
15
+ model-index:
16
+ - name: Whisper Small Uzbek
17
+ results:
18
+ - task:
19
+ type: automatic-speech-recognition
20
+ name: Automatic Speech Recognition
21
+ dataset:
22
+ name: Common Voice 17.0
23
+ type: mozilla-foundation/common_voice_17_0
24
+ args: 'config: uz, split: test'
25
+ metrics:
26
+ - type: wer
27
+ value: 35.8660
28
+ name: Wer
29
  ---
30
 
31
+ <!-- This model card has been generated automatically according to the information the Trainer had access to. You
32
+ should probably proofread and complete it, then remove this comment. -->
33
 
34
+ # Whisper Small Uzbek
35
 
36
+ This model is a fine-tuned version of [openai/whisper-small](https://huggingface.co/openai/whisper-small) on the Common Voice 17.0 dataset.
37
+ It achieves the following results on the evaluation set:
38
+ - Loss: 0.3776
39
+ - Wer: 35.8660
40
 
41
+ ## Model description
42
 
43
+ More information needed
44
 
45
+ ## Intended uses & limitations
46
 
47
+ More information needed
48
 
49
+ ## Training and evaluation data
50
 
51
+ More information needed
 
 
 
 
 
 
52
 
53
+ ## Training procedure
54
 
55
+ ### Training hyperparameters
56
 
57
+ The following hyperparameters were used during training:
58
+ - learning_rate: 2e-05
59
+ - train_batch_size: 16
60
+ - eval_batch_size: 16
61
+ - seed: 42
62
+ - optimizer: Use adamw_torch with betas=(0.9,0.999) and epsilon=1e-08 and optimizer_args=No additional optimizer arguments
63
+ - lr_scheduler_type: linear
64
+ - lr_scheduler_warmup_steps: 1500
65
+ - training_steps: 5500
66
+ - mixed_precision_training: Native AMP
67
 
68
+ ### Training results
69
 
70
+ | Training Loss | Epoch | Step | Validation Loss | Wer |
71
+ |:-------------:|:-----:|:----:|:---------------:|:-------:|
72
+ | 0.913 | 0.2 | 500 | 0.8213 | 62.5843 |
73
+ | 0.6404 | 0.4 | 1000 | 0.6082 | 51.8716 |
74
+ | 0.5734 | 0.6 | 1500 | 0.5458 | 48.0513 |
75
+ | 0.5051 | 0.8 | 2000 | 0.4846 | 43.8649 |
76
+ | 0.4407 | 1.0 | 2500 | 0.4483 | 41.3901 |
77
+ | 0.3436 | 1.2 | 3000 | 0.4321 | 41.0277 |
78
+ | 0.3092 | 1.4 | 3500 | 0.4184 | 40.1141 |
79
+ | 0.2861 | 1.6 | 4000 | 0.4091 | 39.9753 |
80
+ | 0.289 | 1.8 | 4500 | 0.3811 | 36.7950 |
81
+ | 0.2816 | 2.0 | 5000 | 0.3730 | 36.7102 |
82
+ | 0.1547 | 2.2 | 5500 | 0.3776 | 35.8660 |
83
 
 
84
 
85
+ ### Framework versions
86
 
87
+ - Transformers 4.47.0
88
+ - Pytorch 2.1.1+cu121
89
+ - Datasets 3.2.0
90
+ - Tokenizers 0.21.0