lvwerra HF Staff commited on
Commit
b302fbe
·
1 Parent(s): 24b6151

Update metadata with huggingface_hub

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