stas commited on
Commit
382a0e6
1 Parent(s): 19b8bfc
Files changed (1) hide show
  1. README.md +242 -1
README.md CHANGED
@@ -1,3 +1,244 @@
1
  ---
2
- license: apache-2.0
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+
3
  ---
4
+
5
+
6
+
7
+
8
+
9
+
10
+ # Model Card for m4-80b
11
+
12
+ <!-- Provide a quick summary of what the model is/does. [Optional] -->
13
+ Some cool model...
14
+
15
+
16
+
17
+
18
+ # Table of Contents
19
+
20
+ - [Model Card for m4-80b](#model-card-for--model_id-)
21
+ - [Table of Contents](#table-of-contents)
22
+ - [Table of Contents](#table-of-contents-1)
23
+ - [Model Details](#model-details)
24
+ - [Model Description](#model-description)
25
+ - [Uses](#uses)
26
+ - [Direct Use](#direct-use)
27
+ - [Downstream Use [Optional]](#downstream-use-optional)
28
+ - [Out-of-Scope Use](#out-of-scope-use)
29
+ - [Bias, Risks, and Limitations](#bias-risks-and-limitations)
30
+ - [Recommendations](#recommendations)
31
+ - [Training Details](#training-details)
32
+ - [Training Data](#training-data)
33
+ - [Training Procedure](#training-procedure)
34
+ - [Preprocessing](#preprocessing)
35
+ - [Speeds, Sizes, Times](#speeds-sizes-times)
36
+ - [Evaluation](#evaluation)
37
+ - [Testing Data, Factors & Metrics](#testing-data-factors--metrics)
38
+ - [Testing Data](#testing-data)
39
+ - [Factors](#factors)
40
+ - [Metrics](#metrics)
41
+ - [Results](#results)
42
+ - [Model Examination](#model-examination)
43
+ - [Environmental Impact](#environmental-impact)
44
+ - [Technical Specifications [optional]](#technical-specifications-optional)
45
+ - [Model Architecture and Objective](#model-architecture-and-objective)
46
+ - [Compute Infrastructure](#compute-infrastructure)
47
+ - [Hardware](#hardware)
48
+ - [Software](#software)
49
+ - [Citation](#citation)
50
+ - [Glossary [optional]](#glossary-optional)
51
+ - [More Information [optional]](#more-information-optional)
52
+ - [Model Card Authors [optional]](#model-card-authors-optional)
53
+ - [Model Card Contact](#model-card-contact)
54
+ - [How to Get Started with the Model](#how-to-get-started-with-the-model)
55
+
56
+
57
+ # Model Details
58
+
59
+ ## Model Description
60
+
61
+ <!-- Provide a longer summary of what this model is/does. -->
62
+ Some cool model...
63
+
64
+ - **Developed by:** More information needed
65
+ - **Shared by [Optional]:** More information needed
66
+ - **Model type:** Language model
67
+ - **Language(s) (NLP):** en
68
+ - **License:** apache-2.0
69
+ - **Parent Model:** More information needed
70
+ - **Resources for more information:** More information needed
71
+ - [GitHub Repo](https://github.com/huggingface/m4/)
72
+ - [Associated Paper](Flamingo)
73
+
74
+ # Uses
75
+
76
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
77
+
78
+ ## Direct Use
79
+
80
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
81
+ <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
82
+
83
+
84
+
85
+
86
+ ## Downstream Use [Optional]
87
+
88
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
89
+ <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
90
+
91
+
92
+
93
+
94
+ ## Out-of-Scope Use
95
+
96
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
97
+ <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
98
+
99
+
100
+
101
+
102
+ # Bias, Risks, and Limitations
103
+
104
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
105
+
106
+ Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
107
+
108
+
109
+ ## Recommendations
110
+
111
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
112
+
113
+
114
+
115
+
116
+
117
+ # Training Details
118
+
119
+ ## Training Data
120
+
121
+ <!-- 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. -->
122
+
123
+ More information on training data needed
124
+
125
+
126
+ ## Training Procedure
127
+
128
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
129
+
130
+ ### Preprocessing
131
+
132
+ More information needed
133
+
134
+ ### Speeds, Sizes, Times
135
+
136
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
137
+
138
+ More information needed
139
+
140
+ # Evaluation
141
+
142
+ <!-- This section describes the evaluation protocols and provides the results. -->
143
+
144
+ ## Testing Data, Factors & Metrics
145
+
146
+ ### Testing Data
147
+
148
+ <!-- This should link to a Data Card if possible. -->
149
+
150
+ More information needed
151
+
152
+
153
+ ### Factors
154
+
155
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
156
+
157
+ More information needed
158
+
159
+ ### Metrics
160
+
161
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
162
+
163
+ More information needed
164
+
165
+ ## Results
166
+
167
+ More information needed
168
+
169
+ # Model Examination
170
+
171
+ More information needed
172
+
173
+ # Environmental Impact
174
+
175
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
176
+
177
+ 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).
178
+
179
+ - **Hardware Type:** More information needed
180
+ - **Hours used:** More information needed
181
+ - **Cloud Provider:** More information needed
182
+ - **Compute Region:** More information needed
183
+ - **Carbon Emitted:** unknown
184
+
185
+ # Technical Specifications [optional]
186
+
187
+ ## Model Architecture and Objective
188
+
189
+ More information needed
190
+
191
+ ## Compute Infrastructure
192
+
193
+ More information needed
194
+
195
+ ### Hardware
196
+
197
+ More information needed
198
+
199
+ ### Software
200
+
201
+ More information needed
202
+
203
+ # Citation
204
+
205
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
206
+
207
+ **BibTeX:**
208
+
209
+ More information needed
210
+
211
+ **APA:**
212
+
213
+ More information needed
214
+
215
+ # Glossary [optional]
216
+
217
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
218
+
219
+ More information needed
220
+
221
+ # More Information [optional]
222
+
223
+ More information needed
224
+
225
+ # Model Card Authors [optional]
226
+
227
+ <!-- This section provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc. -->
228
+
229
+ V, i, c, t, o, r, ,, , S, t, a, s, ,, , X, X, X
230
+
231
+ # Model Card Contact
232
+
233
+ More information needed
234
+
235
+ # How to Get Started with the Model
236
+
237
+ Use the code below to get started with the model.
238
+
239
+ <details>
240
+ <summary> Click to expand </summary>
241
+
242
+ More information needed
243
+
244
+ </details>