edadaltocg commited on
Commit
19ac849
1 Parent(s): cc7fd4a

Upload README.md with huggingface_hub

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