h9LtLSb commited on
Commit
d8cefdd
1 Parent(s): c10efd7

Update metadata with huggingface_hub

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