jvh commited on
Commit
dfd4387
·
verified ·
1 Parent(s): 63c7a4d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +196 -1
README.md CHANGED
@@ -108,4 +108,199 @@ tags:
108
  - faster-whisper
109
  license: apache-2.0
110
  library_name: ctranslate2
111
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
108
  - faster-whisper
109
  license: apache-2.0
110
  library_name: ctranslate2
111
+ ---
112
+
113
+ # Model Card for Model ID
114
+
115
+ <!-- Provide a quick summary of what the model is/does. -->
116
+
117
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
118
+
119
+ ## Model Details
120
+
121
+ ### Model Description
122
+
123
+ <!-- Provide a longer summary of what this model is. -->
124
+
125
+
126
+
127
+ - **Developed by:** [More Information Needed]
128
+ - **Funded by [optional]:** [More Information Needed]
129
+ - **Shared by [optional]:** [More Information Needed]
130
+ - **Model type:** [More Information Needed]
131
+ - **Language(s) (NLP):** [More Information Needed]
132
+ - **License:** [More Information Needed]
133
+ - **Finetuned from model [optional]:** [More Information Needed]
134
+
135
+ ### Model Sources [optional]
136
+
137
+ <!-- Provide the basic links for the model. -->
138
+
139
+ - **Repository:** [More Information Needed]
140
+ - **Paper [optional]:** [More Information Needed]
141
+ - **Demo [optional]:** [More Information Needed]
142
+
143
+ ## Uses
144
+
145
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
146
+
147
+ ### Direct Use
148
+
149
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
150
+
151
+ [More Information Needed]
152
+
153
+ ### Downstream Use [optional]
154
+
155
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
156
+
157
+ [More Information Needed]
158
+
159
+ ### Out-of-Scope Use
160
+
161
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
162
+
163
+ [More Information Needed]
164
+
165
+ ## Bias, Risks, and Limitations
166
+
167
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
168
+
169
+ [More Information Needed]
170
+
171
+ ### Recommendations
172
+
173
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
174
+
175
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
176
+
177
+ ## How to Get Started with the Model
178
+
179
+ Use the code below to get started with the model.
180
+
181
+ [More Information Needed]
182
+
183
+ ## Training Details
184
+
185
+ ### Training Data
186
+
187
+ <!-- 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. -->
188
+
189
+ [More Information Needed]
190
+
191
+ ### Training Procedure
192
+
193
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
194
+
195
+ #### Preprocessing [optional]
196
+
197
+ [More Information Needed]
198
+
199
+
200
+ #### Training Hyperparameters
201
+
202
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
203
+
204
+ #### Speeds, Sizes, Times [optional]
205
+
206
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
207
+
208
+ [More Information Needed]
209
+
210
+ ## Evaluation
211
+
212
+ <!-- This section describes the evaluation protocols and provides the results. -->
213
+
214
+ ### Testing Data, Factors & Metrics
215
+
216
+ #### Testing Data
217
+
218
+ <!-- This should link to a Dataset Card if possible. -->
219
+
220
+ [More Information Needed]
221
+
222
+ #### Factors
223
+
224
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
225
+
226
+ [More Information Needed]
227
+
228
+ #### Metrics
229
+
230
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
231
+
232
+ [More Information Needed]
233
+
234
+ ### Results
235
+
236
+ [More Information Needed]
237
+
238
+ #### Summary
239
+
240
+
241
+
242
+ ## Model Examination [optional]
243
+
244
+ <!-- Relevant interpretability work for the model goes here -->
245
+
246
+ [More Information Needed]
247
+
248
+ ## Environmental Impact
249
+
250
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
251
+
252
+ 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).
253
+
254
+ - **Hardware Type:** [More Information Needed]
255
+ - **Hours used:** [More Information Needed]
256
+ - **Cloud Provider:** [More Information Needed]
257
+ - **Compute Region:** [More Information Needed]
258
+ - **Carbon Emitted:** [More Information Needed]
259
+
260
+ ## Technical Specifications [optional]
261
+
262
+ ### Model Architecture and Objective
263
+
264
+ [More Information Needed]
265
+
266
+ ### Compute Infrastructure
267
+
268
+ [More Information Needed]
269
+
270
+ #### Hardware
271
+
272
+ [More Information Needed]
273
+
274
+ #### Software
275
+
276
+ [More Information Needed]
277
+
278
+ ## Citation [optional]
279
+
280
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
281
+
282
+ **BibTeX:**
283
+
284
+ [More Information Needed]
285
+
286
+ **APA:**
287
+
288
+ [More Information Needed]
289
+
290
+ ## Glossary [optional]
291
+
292
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
293
+
294
+ [More Information Needed]
295
+
296
+ ## More Information [optional]
297
+
298
+ [More Information Needed]
299
+
300
+ ## Model Card Authors [optional]
301
+
302
+ [More Information Needed]
303
+
304
+ ## Model Card Contact
305
+
306
+ [More Information Needed]