Dricz commited on
Commit
41e91c9
1 Parent(s): 8df8af3

Update README.md

Browse files

How To Use
'''
from transformers import AutoImageProcessor,AutoModelForImageClassification

from PIL import Image
import requests

url = 'http://images.cocodataset.org/val2017/000000039769.jpg'
image = Image.open(requests.get(url, stream=True).raw)

processor = AutoImageProcessor.from_pretrained('Dricz/food-classifier-224')
model = AutoForImageClassification.from_pretrained('Dricz/food-classifier-224')

inputs = processor(images=image, return_tensors="pt")
outputs = model(**inputs)
logits = outputs.logits
# model predicts one of the 101 food101 classes
predicted_class_idx = logits.argmax(-1).item()
print("Predicted class:", model.config.id2label[predicted_class_idx])
'''

Files changed (1) hide show
  1. README.md +27 -156
README.md CHANGED
@@ -13,76 +13,32 @@ This model is a fine-tuned version of google/vit-base-patch16-224-in21k on the f
13
  <!-- Provide a quick summary of what the model is/does. -->
14
  <ul>Evaluation loss: 0.7166455984115601</ul>
15
  <ul>Accuracy: 0.8753663366336634</ul>
16
- 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).
17
 
18
- ## Model Details
19
 
 
 
20
  ### Model Description
21
 
22
  <!-- Provide a longer summary of what this model is. -->
23
 
24
 
25
 
26
- - **Developed by:** [More Information Needed]
27
- - **Funded by [optional]:** [More Information Needed]
28
- - **Shared by [optional]:** [More Information Needed]
29
- - **Model type:** [More Information Needed]
30
- - **Language(s) (NLP):** [More Information Needed]
31
- - **License:** [More Information Needed]
32
- - **Finetuned from model [optional]:** [More Information Needed]
33
-
34
- ### Model Sources [optional]
35
-
36
- <!-- Provide the basic links for the model. -->
37
-
38
- - **Repository:** [More Information Needed]
39
- - **Paper [optional]:** [More Information Needed]
40
- - **Demo [optional]:** [More Information Needed]
41
-
42
- ## Uses
43
-
44
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
45
-
46
- ### Direct Use
47
-
48
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
49
-
50
- [More Information Needed]
51
-
52
- ### Downstream Use [optional]
53
-
54
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
55
-
56
- [More Information Needed]
57
-
58
- ### Out-of-Scope Use
59
-
60
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
61
-
62
- [More Information Needed]
63
-
64
- ## Bias, Risks, and Limitations
65
-
66
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
67
-
68
- [More Information Needed]
69
 
70
- ### Recommendations
71
-
72
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
73
-
74
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
75
-
76
- ## How to Get Started with the Model
77
-
78
- Use the code below to get started with the model.
79
-
80
- [More Information Needed]
81
 
82
  ## Training Details
83
 
84
  ### Training Data
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]
@@ -98,110 +54,25 @@ Use the code below to get started with the model.
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
- TrainOutput(global_step=4735, training_loss=1.7299224627936907, metrics={'train_runtime': 3538.2995, 'train_samples_per_second': 21.409, 'train_steps_per_second': 1.338, 'total_flos': 5.8752267138432e+18, 'train_loss': 1.7299224627936907, 'epoch': 1.0})
105
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
 
 
 
106
 
107
  [More Information Needed]
108
 
109
  ## Evaluation
110
 
111
  <!-- This section describes the evaluation protocols and provides the results. -->
112
- eval_loss: 0.7166455984115601
113
- eval_accuracy: 0.8753663366336634, 'eval_runtime': 446.9362, 'eval_samples_per_second': 56.496, 'eval_steps_per_second': 3.533, 'epoch': 1.0
114
-
115
- ### Testing Data, Factors & Metrics
116
-
117
- #### Testing Data
118
-
119
- <!-- This should link to a Dataset Card if possible. -->
120
-
121
- [More Information Needed]
122
-
123
- #### Factors
124
-
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
-
135
- ### Results
136
-
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
-
142
-
143
- ## Model Examination [optional]
144
-
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
-
149
- ## Environmental Impact
150
-
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
152
-
153
- 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).
154
-
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
-
161
- ## Technical Specifications [optional]
162
-
163
- ### Model Architecture and Objective
164
-
165
- [More Information Needed]
166
-
167
- ### Compute Infrastructure
168
-
169
- [More Information Needed]
170
-
171
- #### Hardware
172
-
173
- [More Information Needed]
174
-
175
- #### Software
176
-
177
- [More Information Needed]
178
-
179
- ## Citation [optional]
180
-
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
182
-
183
- **BibTeX:**
184
-
185
- [More Information Needed]
186
-
187
- **APA:**
188
-
189
- [More Information Needed]
190
-
191
- ## Glossary [optional]
192
-
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
194
-
195
- [More Information Needed]
196
-
197
- ## More Information [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Authors [optional]
202
-
203
- [More Information Needed]
204
-
205
- ## Model Card Contact
206
 
207
- [More Information Needed]
 
13
  <!-- Provide a quick summary of what the model is/does. -->
14
  <ul>Evaluation loss: 0.7166455984115601</ul>
15
  <ul>Accuracy: 0.8753663366336634</ul>
 
16
 
 
17
 
18
+ ## Model Details
19
+ A model that can detect 101 variety of food.
20
  ### Model Description
21
 
22
  <!-- Provide a longer summary of what this model is. -->
23
 
24
 
25
 
26
+ - **Developed by:** Dricz
27
+ - **Model type:** Image classification
28
+ - **Language(s) (NLP):** English
29
+ - **Finetuned from model:** google/vit-base-patch16-224-in21k
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
 
 
 
 
 
 
 
 
 
 
 
 
31
 
32
  ## Training Details
33
 
34
  ### Training Data
35
+ -**training_loss:** 1.
36
+ -**train_runtime:** 3538
37
+ -**train_samples_per_second:** 21.409
38
+ -**train_steps_per_second:** 1.338
39
+ -**total_flos:** 5.8752267138432e+18
40
+ -**train_loss:** 1.7299224627936907
41
+ -**epoch:** 1.0
42
  <!-- 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. -->
43
 
44
  [More Information Needed]
 
54
 
55
  #### Training Hyperparameters
56
 
57
+ The following hyperparameters were used during training:
58
 
59
+ -**learning_rate:** 5e-05
60
+ -**train_batch_size**: 16
61
+ -**eval_batch_size:** 16
62
+ -**seed:** 42
63
+ -**optimizer:** Adam with betas=(0.9,0.999) and epsilon=1e-08
64
+ -**lr_scheduler_type:** linear
65
+ -**num_epochs:** 1
66
 
67
  [More Information Needed]
68
 
69
  ## Evaluation
70
 
71
  <!-- This section describes the evaluation protocols and provides the results. -->
72
+ -**eval_loss:** 0.7166455984115601
73
+ -**eval_accuracy:** 0.8753663366336634
74
+ -**eval_runtime:** 446.9362
75
+ -**eval_samples_per_second:** 56.496
76
+ -**eval_steps_per_second:** 3.533
77
+ -**epoch:** 1.0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
78