DavidErikMollberg commited on
Commit
260b8df
·
1 Parent(s): ef389b6

Update metadata with huggingface_hub

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