ma2za commited on
Commit
e3d1ef2
1 Parent(s): db01f06

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +1 -104
README.md CHANGED
@@ -22,7 +22,7 @@ model-index:
22
  metrics:
23
  - name: Accuracy
24
  type: accuracy
25
- value: 0.92
26
  ---
27
  # Model Card for Model ID
28
 
@@ -53,40 +53,6 @@ This modelcard aims to be a base template for new models. It has been generated
53
  - **Paper [optional]:** [More Information Needed]
54
  - **Demo [optional]:** [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 recommendations.
89
-
90
  ## How to Get Started with the Model
91
 
92
  Use the code below to get started with the model.
@@ -114,12 +80,6 @@ Use the code below to get started with the model.
114
 
115
  - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
116
 
117
- #### Speeds, Sizes, Times [optional]
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. -->
@@ -132,12 +92,6 @@ Use the code below to get started with the model.
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. -->
@@ -150,72 +104,15 @@ Use the code below to get started with the model.
150
 
151
  #### Summary
152
 
153
-
154
-
155
- ## Model Examination [optional]
156
-
157
- <!-- Relevant interpretability work for the model goes here -->
158
-
159
- [More Information Needed]
160
-
161
- ## Environmental Impact
162
-
163
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
164
-
165
- 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).
166
-
167
- - **Hardware Type:** [More Information Needed]
168
- - **Hours used:** [More Information Needed]
169
- - **Cloud Provider:** [More Information Needed]
170
- - **Compute Region:** [More Information Needed]
171
- - **Carbon Emitted:** [More Information Needed]
172
-
173
  ## Technical Specifications [optional]
174
 
175
  ### Model Architecture and Objective
176
 
177
  [More Information Needed]
178
 
179
- ### Compute Infrastructure
180
-
181
- [More Information Needed]
182
-
183
- #### Hardware
184
-
185
- [More Information Needed]
186
-
187
- #### Software
188
-
189
- [More Information Needed]
190
-
191
- ## Citation [optional]
192
-
193
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
194
-
195
- **BibTeX:**
196
-
197
- [More Information Needed]
198
-
199
- **APA:**
200
-
201
- [More Information Needed]
202
-
203
- ## Glossary [optional]
204
-
205
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
206
-
207
- [More Information Needed]
208
-
209
- ## More Information [optional]
210
-
211
- [More Information Needed]
212
 
213
  ## Model Card Authors [optional]
214
 
215
  [More Information Needed]
216
 
217
- ## Model Card Contact
218
-
219
- [More Information Needed]
220
-
221
 
 
22
  metrics:
23
  - name: Accuracy
24
  type: accuracy
25
+ value: 0.93
26
  ---
27
  # Model Card for Model ID
28
 
 
53
  - **Paper [optional]:** [More Information Needed]
54
  - **Demo [optional]:** [More Information Needed]
55
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
  ## How to Get Started with the Model
57
 
58
  Use the code below to get started with the model.
 
80
 
81
  - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
82
 
 
 
 
 
 
 
83
  ## Evaluation
84
 
85
  <!-- This section describes the evaluation protocols and provides the results. -->
 
92
 
93
  [More Information Needed]
94
 
 
 
 
 
 
 
95
  #### Metrics
96
 
97
  <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
104
 
105
  #### Summary
106
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
107
  ## Technical Specifications [optional]
108
 
109
  ### Model Architecture and Objective
110
 
111
  [More Information Needed]
112
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
113
 
114
  ## Model Card Authors [optional]
115
 
116
  [More Information Needed]
117
 
 
 
 
 
118