BenjaminOcampo commited on
Commit
86eeb36
1 Parent(s): b9e3a3d

Upload README.md with huggingface_hub

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