fsicoli commited on
Commit
ab45dfc
1 Parent(s): 4dcb6fd

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +221 -0
README.md ADDED
@@ -0,0 +1,221 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc
3
+ datasets:
4
+ - fsicoli/common_voice_16_0
5
+ language:
6
+ - pt
7
+ metrics:
8
+ - wer 0.1076
9
+ ---
10
+ # Whisper Large v3 Portuguese
11
+
12
+ <!-- Provide a quick summary of what the model is/does. -->
13
+
14
+ This model is a fine-tuned version of [openai/whisper-large-v3] (https://huggingface.co/openai/whisper-large-v3) on Portuguese using the train and validation split of [Common Voice 16] (https://huggingface.co/datasets/fsicoli/common_voice_16_0).
15
+
16
+ ## Usage
17
+
18
+ ```
19
+ from transformers import pipeline
20
+
21
+ transcriber = pipeline(
22
+ "automatic-speech-recognition",
23
+ model="fsicoli/whisper-large-v3-pt-cv16"
24
+ )
25
+
26
+ transcriber.model.config.forced_decoder_ids = (
27
+ transcriber.tokenizer.get_decoder_prompt_ids(
28
+ language="pt",
29
+ task="transcribe"
30
+ )
31
+ )
32
+
33
+ transcription = transcriber("path/to/my_audio.wav")
34
+ ```
35
+
36
+ ### Model Description
37
+
38
+ <!-- Provide a longer summary of what this model is. -->
39
+
40
+
41
+
42
+ - **Developed by:** [More Information Needed]
43
+ - **Funded by [optional]:** [More Information Needed]
44
+ - **Shared by [optional]:** [More Information Needed]
45
+ - **Model type:** [More Information Needed]
46
+ - **Language(s) (NLP):** [More Information Needed]
47
+ - **License:** [More Information Needed]
48
+ - **Finetuned from model [optional]:** [More Information Needed]
49
+
50
+ ### Model Sources [optional]
51
+
52
+ <!-- Provide the basic links for the model. -->
53
+
54
+ - **Repository:** [More Information Needed]
55
+ - **Paper [optional]:** [More Information Needed]
56
+ - **Demo [optional]:** [More Information Needed]
57
+
58
+ ## Uses
59
+
60
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
61
+
62
+ ### Direct Use
63
+
64
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
65
+
66
+ [More Information Needed]
67
+
68
+ ### Downstream Use [optional]
69
+
70
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
71
+
72
+ [More Information Needed]
73
+
74
+ ### Out-of-Scope Use
75
+
76
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
77
+
78
+ [More Information Needed]
79
+
80
+ ## Bias, Risks, and Limitations
81
+
82
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
83
+
84
+ [More Information Needed]
85
+
86
+ ### Recommendations
87
+
88
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
89
+
90
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
91
+
92
+ ## How to Get Started with the Model
93
+
94
+ Use the code below to get started with the model.
95
+
96
+ [More Information Needed]
97
+
98
+ ## Training Details
99
+
100
+ ### Training Data
101
+
102
+ <!-- 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. -->
103
+
104
+ [More Information Needed]
105
+
106
+ ### Training Procedure
107
+
108
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
109
+
110
+ #### Preprocessing [optional]
111
+
112
+ [More Information Needed]
113
+
114
+
115
+ #### Training Hyperparameters
116
+
117
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
118
+
119
+ #### Speeds, Sizes, Times [optional]
120
+
121
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
122
+
123
+ [More Information Needed]
124
+
125
+ ## Evaluation
126
+
127
+ <!-- This section describes the evaluation protocols and provides the results. -->
128
+
129
+ ### Testing Data, Factors & Metrics
130
+
131
+ #### Testing Data
132
+
133
+ Test split of [Common Voice 16] (https://huggingface.co/datasets/fsicoli/common_voice_16_0).
134
+
135
+ [More Information Needed]
136
+
137
+ #### Factors
138
+
139
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
140
+
141
+ [More Information Needed]
142
+
143
+ #### Metrics
144
+
145
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
146
+
147
+ [More Information Needed]
148
+
149
+ ### Results
150
+
151
+ [More Information Needed]
152
+
153
+ #### Summary
154
+
155
+
156
+
157
+ ## Model Examination [optional]
158
+
159
+ <!-- Relevant interpretability work for the model goes here -->
160
+
161
+ [More Information Needed]
162
+
163
+ ## Environmental Impact
164
+
165
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
166
+
167
+ 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).
168
+
169
+ - **Hardware Type:** [More Information Needed]
170
+ - **Hours used:** [More Information Needed]
171
+ - **Cloud Provider:** [More Information Needed]
172
+ - **Compute Region:** [More Information Needed]
173
+ - **Carbon Emitted:** [More Information Needed]
174
+
175
+ ## Technical Specifications [optional]
176
+
177
+ ### Model Architecture and Objective
178
+
179
+ [More Information Needed]
180
+
181
+ ### Compute Infrastructure
182
+
183
+ [More Information Needed]
184
+
185
+ #### Hardware
186
+
187
+ [More Information Needed]
188
+
189
+ #### Software
190
+
191
+ [More Information Needed]
192
+
193
+ ## Citation [optional]
194
+
195
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
196
+
197
+ **BibTeX:**
198
+
199
+ [More Information Needed]
200
+
201
+ **APA:**
202
+
203
+ [More Information Needed]
204
+
205
+ ## Glossary [optional]
206
+
207
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
208
+
209
+ [More Information Needed]
210
+
211
+ ## More Information [optional]
212
+
213
+ [More Information Needed]
214
+
215
+ ## Model Card Authors [optional]
216
+
217
+ [More Information Needed]
218
+
219
+ ## Model Card Contact
220
+
221
+ [More Information Needed]