Snarci commited on
Commit
768efd1
1 Parent(s): faa9bf6

Update README.md

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