EricCRX commited on
Commit
954cb89
·
verified ·
1 Parent(s): e8bb944

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +124 -29
README.md CHANGED
@@ -1,29 +1,124 @@
1
- ---
2
- license: mit
3
- configs:
4
- - config_name: default
5
- data_files:
6
- - split: original
7
- path: data/original-*
8
- - split: augmented
9
- path: data/augmented-*
10
- dataset_info:
11
- features:
12
- - name: image
13
- dtype: image
14
- - name: label
15
- dtype:
16
- class_label:
17
- names:
18
- '0': food
19
- '1': view
20
- splits:
21
- - name: original
22
- num_bytes: 371487.0
23
- num_examples: 32
24
- - name: augmented
25
- num_bytes: 4075054.0
26
- num_examples: 352
27
- download_size: 4411701
28
- dataset_size: 4446541.0
29
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ configs:
4
+ - config_name: default
5
+ data_files:
6
+ - split: original
7
+ path: data/original-*
8
+ - split: augmented
9
+ path: data/augmented-*
10
+ dataset_info:
11
+ features:
12
+ - name: image
13
+ dtype: image
14
+ - name: label
15
+ dtype:
16
+ class_label:
17
+ names:
18
+ '0': food
19
+ '1': view
20
+ splits:
21
+ - name: original
22
+ num_bytes: 371487.0
23
+ num_examples: 32
24
+ - name: augmented
25
+ num_bytes: 4075054.0
26
+ num_examples: 352
27
+ download_size: 4411701
28
+ dataset_size: 4446541.0
29
+ ---
30
+
31
+
32
+ # 📄 Model Card: Food vs View Image Dataset
33
+
34
+ ## 1. Purpose
35
+ This dataset was created for educational purposes as part of Homework 1 (*Dealing with Data*).
36
+ It demonstrates how to build, preprocess, augment, and upload an image dataset to Hugging Face.
37
+ The dataset supports binary image classification tasks and shows how augmentation can expand small collections into larger, balanced sets.
38
+
39
+ ---
40
+
41
+ ## 2. Composition
42
+ - **Domain:** Everyday life photos.
43
+ - **Samples:** 32 unique, student-created images.
44
+ - **Classes (binary target):**
45
+ - `food` → meals, snacks, and beverages.
46
+ - `view` → landscapes, outdoor scenery.
47
+ - **Split Sizes:**
48
+ - Original: 32 images
49
+ - Augmented: 352 images
50
+
51
+ ---
52
+
53
+ ## 3. Collection Process
54
+ - **Source:** All original images were taken by the student using a phone camera.
55
+ - **Content:** Food photos are close-ups of meals, while view photos capture outdoor landscapes.
56
+ - **Format:** JPEG/PNG images.
57
+ - **Resolution:** Resized to 224×224 pixels.
58
+ - **Ethical Assurance:** No faces, people, or personal identifiers are included.
59
+
60
+ ---
61
+
62
+ ## 4. Preprocessing & Augmentation
63
+ - **Preprocessing:**
64
+ - Resized all images to 224×224.
65
+ - Converted to RGB format.
66
+ - **Augmentation Techniques (label-preserving):**
67
+ - Horizontal/vertical flips
68
+ - Random rotations (0°, 90°, 180°, 270°)
69
+ - Brightness/contrast adjustments
70
+ - Random cropping and scaling
71
+ - **Goal:** Expand dataset to ≥300 samples while preserving labels.
72
+
73
+ ---
74
+
75
+ ## 5. Labels
76
+ - **Target Variable:** `label`
77
+ - **Values:**
78
+ - `0`: food
79
+ - `1`: view
80
+
81
+ ---
82
+
83
+ ## 6. Splits
84
+ - **Original split:** 32 manually collected images (`original`).
85
+ - **Augmented split:** 352 synthetic variants via documented augmentation techniques (`augmented`).
86
+
87
+ ---
88
+
89
+ ## 7. Exploratory Data Analysis (EDA)
90
+ Below are random samples from both classes:
91
+
92
+ ![EDA Contact Sheet](eda_contact_sheet.png)
93
+
94
+ - **Class counts:** 15 food, 17 view
95
+ - **Observation:** Food images tend to be close-up shots under artificial lighting, while view images capture natural scenery with broader perspectives.
96
+
97
+ ---
98
+
99
+ ## 8. Intended Use / Limitations
100
+ - **Use:**
101
+ - Educational demo for binary image classification.
102
+ - Practice with preprocessing, augmentation, and Hugging Face uploads.
103
+ - **Limitations:**
104
+ - Small dataset; not suitable for real-world production.
105
+ - Augmentation does not fully capture real-world variability.
106
+
107
+ ---
108
+
109
+ ## 9. Ethical Considerations
110
+ - Images are student-owned and contain no personal or sensitive data.
111
+ - Dataset is safe for academic and research use.
112
+
113
+ ---
114
+
115
+ ## 10. License
116
+ Released under the **MIT License** for educational and research purposes.
117
+
118
+ ---
119
+
120
+ ## 11. AI Usage Disclosure
121
+ - **Original images (32):** Taken by the student.
122
+ - **Augmentation:** Generated via Python libraries (e.g., `torchvision.transforms`).
123
+ - **Documentation:** Drafted with the assistance of AI tools (ChatGPT) but reviewed and finalized manually.
124
+