GianTan commited on
Commit
5178f9c
·
verified ·
1 Parent(s): 072c5e9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -106
README.md CHANGED
@@ -18,55 +18,28 @@ tags: []
18
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
  - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [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
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
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
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
 
58
  ## Bias, Risks, and Limitations
59
 
60
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
 
62
- [More Information Needed]
63
 
64
  ### Recommendations
65
 
66
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
 
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
  ## How to Get Started with the Model
71
 
72
  Use the code below to get started with the model.
@@ -85,26 +58,16 @@ unmasker("mura kag [MASK].")
85
 
86
  <!-- 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. -->
87
 
88
- [More Information Needed]
89
-
90
- ### Training Procedure
91
-
92
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
93
-
94
- #### Preprocessing [optional]
95
-
96
- [More Information Needed]
97
 
98
 
99
  #### Training Hyperparameters
100
 
101
  - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
102
 
103
- #### Speeds, Sizes, Times [optional]
104
 
105
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
106
 
107
- [More Information Needed]
108
 
109
  ## Evaluation
110
 
@@ -116,24 +79,9 @@ unmasker("mura kag [MASK].")
116
 
117
  <!-- This should link to a Dataset Card if possible. -->
118
 
119
- [More Information Needed]
120
-
121
- #### Factors
122
-
123
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
124
-
125
- [More Information Needed]
126
-
127
- #### Metrics
128
-
129
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
130
-
131
- [More Information Needed]
132
 
133
  ### Results
134
 
135
- [More Information Needed]
136
-
137
  #### Summary
138
 
139
 
@@ -142,64 +90,13 @@ unmasker("mura kag [MASK].")
142
 
143
  <!-- Relevant interpretability work for the model goes here -->
144
 
145
- [More Information Needed]
146
-
147
- ## Environmental Impact
148
-
149
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
150
-
151
- 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).
152
-
153
- - **Hardware Type:** [More Information Needed]
154
- - **Hours used:** [More Information Needed]
155
- - **Cloud Provider:** [More Information Needed]
156
- - **Compute Region:** [More Information Needed]
157
- - **Carbon Emitted:** [More Information Needed]
158
-
159
- ## Technical Specifications [optional]
160
-
161
- ### Model Architecture and Objective
162
-
163
- [More Information Needed]
164
-
165
- ### Compute Infrastructure
166
-
167
- [More Information Needed]
168
 
169
- #### Hardware
170
 
171
- [More Information Needed]
172
-
173
- #### Software
174
-
175
- [More Information Needed]
176
 
177
- ## Citation [optional]
178
 
179
  <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
180
 
181
  **BibTeX:**
182
 
183
  [More Information Needed]
184
-
185
- **APA:**
186
-
187
- [More Information Needed]
188
-
189
- ## Glossary [optional]
190
-
191
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
192
-
193
- [More Information Needed]
194
-
195
- ## More Information [optional]
196
-
197
- [More Information Needed]
198
-
199
- ## Model Card Authors [optional]
200
-
201
- [More Information Needed]
202
-
203
- ## Model Card Contact
204
-
205
- [More Information Needed]
 
18
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
  - **Developed by:** [More Information Needed]
 
 
21
  - **Model type:** [More Information Needed]
22
  - **Language(s) (NLP):** [More Information Needed]
23
  - **License:** [More Information Needed]
 
24
 
25
  ### Model Sources [optional]
26
 
27
  <!-- Provide the basic links for the model. -->
28
 
29
  - **Repository:** [More Information Needed]
30
+ - **Paper:** [More Information Needed]
 
31
 
 
32
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
33
 
34
  ## Bias, Risks, and Limitations
35
 
36
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
37
 
 
38
 
39
  ### Recommendations
40
 
41
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
42
 
 
 
43
  ## How to Get Started with the Model
44
 
45
  Use the code below to get started with the model.
 
58
 
59
  <!-- 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. -->
60
 
 
 
 
 
 
 
 
 
 
61
 
62
 
63
  #### Training Hyperparameters
64
 
65
  - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
66
 
67
+ #### Speeds, Sizes, Times
68
 
69
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
70
 
 
71
 
72
  ## Evaluation
73
 
 
79
 
80
  <!-- This should link to a Dataset Card if possible. -->
81
 
 
 
 
 
 
 
 
 
 
 
 
 
 
82
 
83
  ### Results
84
 
 
 
85
  #### Summary
86
 
87
 
 
90
 
91
  <!-- Relevant interpretability work for the model goes here -->
92
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
93
 
 
94
 
 
 
 
 
 
95
 
96
+ ## Citation
97
 
98
  <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
99
 
100
  **BibTeX:**
101
 
102
  [More Information Needed]