jvh commited on
Commit
88da9eb
1 Parent(s): 693478c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +308 -0
README.md CHANGED
@@ -1,3 +1,311 @@
1
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  license: apache-2.0
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ language:
3
+ - en
4
+ - zh
5
+ - de
6
+ - es
7
+ - ru
8
+ - ko
9
+ - fr
10
+ - ja
11
+ - pt
12
+ - tr
13
+ - pl
14
+ - ca
15
+ - nl
16
+ - ar
17
+ - sv
18
+ - it
19
+ - id
20
+ - hi
21
+ - fi
22
+ - vi
23
+ - he
24
+ - uk
25
+ - el
26
+ - ms
27
+ - cs
28
+ - ro
29
+ - da
30
+ - hu
31
+ - ta
32
+ - 'no'
33
+ - th
34
+ - ur
35
+ - hr
36
+ - bg
37
+ - lt
38
+ - la
39
+ - mi
40
+ - ml
41
+ - cy
42
+ - sk
43
+ - te
44
+ - fa
45
+ - lv
46
+ - bn
47
+ - sr
48
+ - az
49
+ - sl
50
+ - kn
51
+ - et
52
+ - mk
53
+ - br
54
+ - eu
55
+ - is
56
+ - hy
57
+ - ne
58
+ - mn
59
+ - bs
60
+ - kk
61
+ - sq
62
+ - sw
63
+ - gl
64
+ - mr
65
+ - pa
66
+ - si
67
+ - km
68
+ - sn
69
+ - yo
70
+ - so
71
+ - af
72
+ - oc
73
+ - ka
74
+ - be
75
+ - tg
76
+ - sd
77
+ - gu
78
+ - am
79
+ - yi
80
+ - lo
81
+ - uz
82
+ - fo
83
+ - ht
84
+ - ps
85
+ - tk
86
+ - nn
87
+ - mt
88
+ - sa
89
+ - lb
90
+ - my
91
+ - bo
92
+ - tl
93
+ - mg
94
+ - as
95
+ - tt
96
+ - haw
97
+ - ln
98
+ - ha
99
+ - ba
100
+ - jw
101
+ - su
102
+ - yue
103
+ tags:
104
+ - audio
105
+ - automatic-speech-recognition
106
+ - int8
107
+ - quanto
108
+ - faster-whisper
109
  license: apache-2.0
110
+ library_name: ctranslate2
111
  ---
112
+
113
+ # Model Card for Model ID
114
+
115
+ This model is quantized using the [Quanto Python Package](https://github.com/huggingface/quanto) and the [CTranslate2 Python Package](https://github.com/OpenNMT/CTranslate2).
116
+ From my early tests:
117
+ - Much less GPU memory required
118
+ - It seems that performance is on par with the original
119
+ - It seems that this combination is faster than just using the CTranslate2 int8 quantization.
120
+ Quantization method TBA.
121
+ To use this model, use the faster_whisper module as stated in [the original faster-whsiper model](https://huggingface.co/Systran/faster-whisper-large-v3)
122
+
123
+ Any benchmark results are appreciated. I probably do not have time to do it myself.
124
+ ## Model Details
125
+
126
+ ### Model Description
127
+
128
+ <!-- Provide a longer summary of what this model is. -->
129
+
130
+
131
+
132
+ - **Developed by:** [More Information Needed]
133
+ - **Funded by [optional]:** [More Information Needed]
134
+ - **Shared by [optional]:** [More Information Needed]
135
+ - **Model type:** [More Information Needed]
136
+ - **Language(s) (NLP):** [More Information Needed]
137
+ - **License:** [More Information Needed]
138
+ - **Finetuned from model [optional]:** [More Information Needed]
139
+
140
+ ### Model Sources [optional]
141
+
142
+ <!-- Provide the basic links for the model. -->
143
+
144
+ - **Repository:** [More Information Needed]
145
+ - **Paper [optional]:** [More Information Needed]
146
+ - **Demo [optional]:** [More Information Needed]
147
+
148
+ ## Uses
149
+
150
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
151
+
152
+ ### Direct Use
153
+
154
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
155
+
156
+ [More Information Needed]
157
+
158
+ ### Downstream Use [optional]
159
+
160
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
161
+
162
+ [More Information Needed]
163
+
164
+ ### Out-of-Scope Use
165
+
166
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
167
+
168
+ [More Information Needed]
169
+
170
+ ## Bias, Risks, and Limitations
171
+
172
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
173
+
174
+ [More Information Needed]
175
+
176
+ ### Recommendations
177
+
178
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
179
+
180
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
181
+
182
+ ## How to Get Started with the Model
183
+
184
+ Use the code below to get started with the model.
185
+
186
+ [More Information Needed]
187
+
188
+ ## Training Details
189
+
190
+ ### Training Data
191
+
192
+ <!-- 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. -->
193
+
194
+ [More Information Needed]
195
+
196
+ ### Training Procedure
197
+
198
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
199
+
200
+ #### Preprocessing [optional]
201
+
202
+ [More Information Needed]
203
+
204
+
205
+ #### Training Hyperparameters
206
+
207
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
208
+
209
+ #### Speeds, Sizes, Times [optional]
210
+
211
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
212
+
213
+ [More Information Needed]
214
+
215
+ ## Evaluation
216
+
217
+ <!-- This section describes the evaluation protocols and provides the results. -->
218
+
219
+ ### Testing Data, Factors & Metrics
220
+
221
+ #### Testing Data
222
+
223
+ <!-- This should link to a Dataset Card if possible. -->
224
+
225
+ [More Information Needed]
226
+
227
+ #### Factors
228
+
229
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
230
+
231
+ [More Information Needed]
232
+
233
+ #### Metrics
234
+
235
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
236
+
237
+ [More Information Needed]
238
+
239
+ ### Results
240
+
241
+ [More Information Needed]
242
+
243
+ #### Summary
244
+
245
+
246
+
247
+ ## Model Examination [optional]
248
+
249
+ <!-- Relevant interpretability work for the model goes here -->
250
+
251
+ [More Information Needed]
252
+
253
+ ## Environmental Impact
254
+
255
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
256
+
257
+ 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).
258
+
259
+ - **Hardware Type:** [More Information Needed]
260
+ - **Hours used:** [More Information Needed]
261
+ - **Cloud Provider:** [More Information Needed]
262
+ - **Compute Region:** [More Information Needed]
263
+ - **Carbon Emitted:** [More Information Needed]
264
+
265
+ ## Technical Specifications [optional]
266
+
267
+ ### Model Architecture and Objective
268
+
269
+ [More Information Needed]
270
+
271
+ ### Compute Infrastructure
272
+
273
+ [More Information Needed]
274
+
275
+ #### Hardware
276
+
277
+ [More Information Needed]
278
+
279
+ #### Software
280
+
281
+ [More Information Needed]
282
+
283
+ ## Citation [optional]
284
+
285
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
286
+
287
+ **BibTeX:**
288
+
289
+ [More Information Needed]
290
+
291
+ **APA:**
292
+
293
+ [More Information Needed]
294
+
295
+ ## Glossary [optional]
296
+
297
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
298
+
299
+ [More Information Needed]
300
+
301
+ ## More Information [optional]
302
+
303
+ [More Information Needed]
304
+
305
+ ## Model Card Authors [optional]
306
+
307
+ [More Information Needed]
308
+
309
+ ## Model Card Contact
310
+
311
+ [More Information Needed]