dijihax commited on
Commit
e638f9a
·
verified ·
1 Parent(s): 0974e84

Update README.md

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