catlove007 commited on
Commit
a381747
·
1 Parent(s): 3b39ef2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -167
README.md CHANGED
@@ -18,20 +18,12 @@ This modelcard aims to be a base template for new models. It has been generated
18
 
19
 
20
 
21
- - **Developed by:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
  - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
 
36
  ## Uses
37
 
@@ -41,7 +33,6 @@ This modelcard aims to be a base template for new models. It has been generated
41
 
42
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
 
44
- [More Information Needed]
45
  ```[python]
46
  class CFG:
47
  print_freq = 500
@@ -104,159 +95,7 @@ model = custom_model(CFG)
104
  model.load_state_dict(torch.load('./model_saved/custom_model_weights.pth')['model'])
105
  ```
106
 
107
- ### Downstream Use [optional]
108
-
109
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
110
-
111
- [More Information Needed]
112
-
113
- ### Out-of-Scope Use
114
-
115
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
116
-
117
- [More Information Needed]
118
-
119
- ## Bias, Risks, and Limitations
120
-
121
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
122
-
123
- [More Information Needed]
124
-
125
- ### Recommendations
126
-
127
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
128
-
129
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
130
-
131
- ## How to Get Started with the Model
132
-
133
- Use the code below to get started with the model.
134
-
135
- [More Information Needed]
136
-
137
- ## Training Details
138
-
139
- ### Training Data
140
-
141
- <!-- 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. -->
142
-
143
- [More Information Needed]
144
-
145
- ### Training Procedure
146
-
147
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
148
-
149
- #### Preprocessing [optional]
150
-
151
- [More Information Needed]
152
-
153
-
154
- #### Training Hyperparameters
155
-
156
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
157
-
158
- #### Speeds, Sizes, Times [optional]
159
-
160
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
161
-
162
- [More Information Needed]
163
-
164
  ## Evaluation
165
 
166
- <!-- This section describes the evaluation protocols and provides the results. -->
167
-
168
- ### Testing Data, Factors & Metrics
169
-
170
- #### Testing Data
171
-
172
- <!-- This should link to a Data Card if possible. -->
173
-
174
- [More Information Needed]
175
-
176
- #### Factors
177
-
178
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
179
-
180
- [More Information Needed]
181
-
182
- #### Metrics
183
-
184
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
185
-
186
- [More Information Needed]
187
-
188
- ### Results
189
-
190
- [More Information Needed]
191
-
192
- #### Summary
193
-
194
-
195
-
196
- ## Model Examination [optional]
197
-
198
- <!-- Relevant interpretability work for the model goes here -->
199
-
200
- [More Information Needed]
201
-
202
- ## Environmental Impact
203
-
204
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
205
-
206
- 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).
207
-
208
- - **Hardware Type:** [More Information Needed]
209
- - **Hours used:** [More Information Needed]
210
- - **Cloud Provider:** [More Information Needed]
211
- - **Compute Region:** [More Information Needed]
212
- - **Carbon Emitted:** [More Information Needed]
213
-
214
- ## Technical Specifications [optional]
215
-
216
- ### Model Architecture and Objective
217
-
218
- [More Information Needed]
219
-
220
- ### Compute Infrastructure
221
-
222
- [More Information Needed]
223
-
224
- #### Hardware
225
-
226
- [More Information Needed]
227
-
228
- #### Software
229
-
230
- [More Information Needed]
231
-
232
- ## Citation [optional]
233
-
234
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
235
-
236
- **BibTeX:**
237
-
238
- [More Information Needed]
239
-
240
- **APA:**
241
-
242
- [More Information Needed]
243
-
244
- ## Glossary [optional]
245
-
246
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
247
-
248
- [More Information Needed]
249
-
250
- ## More Information [optional]
251
-
252
- [More Information Needed]
253
-
254
- ## Model Card Authors [optional]
255
-
256
- [More Information Needed]
257
-
258
- ## Model Card Contact
259
-
260
- [More Information Needed]
261
-
262
 
 
18
 
19
 
20
 
21
+ - **Developed by:** catlove
22
+ - **Shared by [optional]:** catlove
23
+ - **Model type:** bert
24
+ - **Language(s) (NLP):** multi-language
25
  - **License:** [More Information Needed]
26
+ - **Finetuned from model [optional]:** xlm-roberta-large
 
 
 
 
 
 
 
 
27
 
28
  ## Uses
29
 
 
33
 
34
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
35
 
 
36
  ```[python]
37
  class CFG:
38
  print_freq = 500
 
95
  model.load_state_dict(torch.load('./model_saved/custom_model_weights.pth')['model'])
96
  ```
97
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
98
  ## Evaluation
99
 
100
+ Our CV score is 0.3797 using a threshold of 0.029.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
101