egrace479 commited on
Commit
bb2c928
1 Parent(s): da67881

updated README with more distribution and structure information

Browse files
Files changed (1) hide show
  1. README.md +104 -33
README.md CHANGED
@@ -25,17 +25,21 @@ size_categories:
25
  ## Dataset Description
26
  Dorsal full body images of subspecies of Heliconius Erato and Heliconius Melpomene (18 subspecies total).
27
  960 images with 320 specimens, each photographed in RGB with bird and butterfly acuity included (3 images of each specimen).
28
- Processed from Cuthill, et. al. dataset available at [doi:10.5061/dryad.2hp1978](https://doi.org/10.5061/dryad.2hp1978).
 
 
29
 
30
  - **Homepage:**
31
- - **Repository:**
32
  - **Paper:**
33
  - **Leaderboard:**
34
  - **Point of Contact:**
35
 
36
  ### Dataset Summary
37
 
 
38
  This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
 
39
 
40
  ### Supported Tasks and Leaderboards
41
 
@@ -47,6 +51,64 @@ This dataset card aims to be a base template for new datasets. It has been gener
47
 
48
  ## Dataset Structure
49
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
  ### Data Instances
51
 
52
  Type: PNG
@@ -59,36 +121,43 @@ Color (ColorChecker, white-balance, None): None
59
 
60
  ### Data Fields
61
 
62
- **In Hoyal_Cuthill_GoldStandard_metadata_cleaned.csv:**
63
-
64
- * 'NHM_Specimen': Natural History Museum Specimen number
65
- * 'Image_filename': filename of image of specimen
66
- * 'View': whether ventral or dorsal view of specimen (all dorsal)
67
- * 'Species': species of specimen (melpomene or erato)
68
- * 'Subspecies': subspecies of the specimen
69
- * 'Sex': sex of the specimen (male or female)
70
- * 'addit_taxa_info': additional taxonomic information (subspecies)
71
- * 'type_stat': [More Information Needed] 'ST', 'PT', or 'HT', but mostly null
72
- * 'hybrid_stat': hybrid status ('valid subspecies', 'subspecies synonym' or 'unknown' (only 1))
73
- * 'in_reduced': [More Information Needed] 0 or 1 to indicate yes or no
74
- * 'locality': [More Information Needed] location of collection or picture
75
- * 'lat': latitude [More Information Needed] location of collection or picture
76
- * 'lon': longitude [More Information Needed] location of collection or picture
77
- * 'speciesdesig': species designation, first initial of species '.' subspecies (eg., 'm. rosina')
78
-
79
- Train_Test_Curated_GoldStandard_Hoyal_Cuthill.csv has three additional columns:
80
  * `Image_filename_png`: filename of (png) image of specimen, `dorsal_images_cuthill/` + `<Image_filename_png>` is the filepath for the processed dorsal image
81
  * `subset`: whether this is part of the training or test set (`train` or `test`)
82
  * `filepath`: the filepath for the train or test image
83
 
84
- Acuity_Curated_GoldStandard_Hoyal_Cuthill.csv also has `Image_filename_png` and `subset`, but `subset` references the bird and butterfly acuity training and test sets. Additionally, it has columns:
85
- `bird_filepath`: the filepath for the bird acuity version of the image
86
- `butterfly_filepath`: the filepath for the butterfly acuity version of the image
87
 
88
 
89
  ### Data Splits
90
 
91
- [More Information Needed]
 
 
 
 
 
 
 
92
 
93
  ## Dataset Creation
94
 
@@ -103,6 +172,8 @@ Processing steps included:
103
 
104
  [More Information Needed]
105
 
 
 
106
  ### Source Data
107
 
108
  Cuthill, et. al. [doi:10.5061/dryad.2hp1978](https://doi.org/10.5061/dryad.2hp1978).
@@ -127,7 +198,7 @@ Cuthill, et. al. [doi:10.5061/dryad.2hp1978](https://doi.org/10.5061/dryad.2hp19
127
 
128
  ### Personal and Sensitive Information
129
 
130
- [More Information Needed]
131
 
132
  ## Considerations for Using the Data
133
 
@@ -141,26 +212,26 @@ Cuthill, et. al. [doi:10.5061/dryad.2hp1978](https://doi.org/10.5061/dryad.2hp19
141
 
142
  ### Other Known Limitations
143
 
144
- No genetic data available.
145
 
146
- Non-uniform distribution of subspecies (imbalanced).
147
 
148
 
149
  ## Additional Information
150
 
151
  ### Dataset Curators
152
 
153
- Krzysztof Kozak (University of California Berkeley) - ORCID: 0000-0001-8980-3173
154
 
155
- Christopher Lawrence (Princeton University) - ORCID: 0000-0002-3846-5968
156
 
157
- James Mallet (Harvard University) - ORCID: 0000-0002-3370-0367
158
 
159
- Owen McMillan (Smithsonian Tropical Research Institute) - ORCID: 0000-0003-2805-2745
160
 
161
- David Carlyn (The Ohio State University) - ORCID: 0000-0002-8323-0359
162
 
163
- Mohannad Elhamod (Virginia Tech) - ORCID: 0000-0002-2383-947X
164
 
165
 
166
  ### Licensing Information
 
25
  ## Dataset Description
26
  Dorsal full body images of subspecies of Heliconius Erato and Heliconius Melpomene (18 subspecies total).
27
  960 images with 320 specimens, each photographed in RGB with bird and butterfly acuity included (3 images of each specimen).
28
+ Subset of images processed from Cuthill, et. al. dataset available at [doi:10.5061/dryad.2hp1978](https://doi.org/10.5061/dryad.2hp1978).
29
+
30
+ **Note:** `dorsal_images_cuthill` contains processed dorsal images from the original Cuthill dataset (all 1,234 specimens).
31
 
32
  - **Homepage:**
33
+ - **Repository:** [Butterfly-mimicry](https://github.com/Imageomics/Butterfly-mimicry) contains research done using this dataset.
34
  - **Paper:**
35
  - **Leaderboard:**
36
  - **Point of Contact:**
37
 
38
  ### Dataset Summary
39
 
40
+ <!---
41
  This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
42
+ --->
43
 
44
  ### Supported Tasks and Leaderboards
45
 
 
51
 
52
  ## Dataset Structure
53
 
54
+
55
+ |-- `dorsal_images_cuthill`
56
+ | |
57
+ | |-- `10427965_D_lowres.tif`
58
+ | |
59
+ | |-- `10427966_D_lowres.tif
60
+ | |
61
+ | | ...
62
+ |
63
+ |-- `Acuities`
64
+ | |
65
+ | |-- `train_bird`
66
+ | |
67
+ | |-- `erato_cyrbia`
68
+ | |
69
+ | |-- `erato_etylus`
70
+ | |
71
+ | | ...
72
+ | |
73
+ | |-- `test_bird`
74
+ | |
75
+ | |-- `erato_cyrbia`
76
+ | |-- `erato_etylus`
77
+ | |
78
+ | | ...
79
+ | |
80
+ | |-- `train_butterfly`
81
+ | |
82
+ | |-- `erato_cyrbia`
83
+ | |
84
+ | |-- `erato_etylus`
85
+ | |
86
+ | | ...
87
+ | |
88
+ | |-- `test_butterfly`
89
+ | |
90
+ | |-- `erato_cyrbia`
91
+ | |
92
+ | |-- `erato_etylus`
93
+ | |
94
+ | | ...
95
+ |
96
+ |-- `train`
97
+ | |
98
+ | |-- `erato_cyrbia`
99
+ | |
100
+ | |-- `erato_etylus`
101
+ | |
102
+ | | ...
103
+ |
104
+ |-- `test`
105
+ | |
106
+ | |-- `erato_cyrbia`
107
+ | |
108
+ | |-- `erato_etylus`
109
+ |
110
+ | ...
111
+
112
  ### Data Instances
113
 
114
  Type: PNG
 
121
 
122
  ### Data Fields
123
 
124
+ **In [Hoyal_Cuthill_GoldStandard_metadata_cleaned.csv]():**
125
+
126
+ * `NHM_Specimen`: Natural History Museum Specimen number
127
+ * `Image_filename`: filename of image of specimen
128
+ * `View`: whether ventral or dorsal view of specimen (all dorsal)
129
+ * `Species`: species of specimen (melpomene or erato)
130
+ * `Subspecies`: subspecies of the specimen
131
+ * `Sex`: sex of the specimen (male or female)
132
+ * `addit_taxa_info`: additional taxonomic information (subspecies)
133
+ * `type_stat`: [More Information Needed] 'ST', 'PT', or 'HT', but mostly null
134
+ * `hybrid_stat`: hybrid status ('valid subspecies', 'subspecies synonym' or 'unknown' (only 1))
135
+ * `in_reduced`: [More Information Needed] 0 or 1 to indicate yes or no
136
+ * `locality`: where specimen was collected
137
+ * `lat`: latitude where specimen was collected
138
+ * `lon`: longitude where specimen was collected
139
+ * `speciesdesig`: species designation, first initial of species '.' subspecies (eg., 'm. rosina')
140
+
141
+ [Train_Test_Curated_GoldStandard_Hoyal_Cuthill.csv]() has three additional columns:
142
  * `Image_filename_png`: filename of (png) image of specimen, `dorsal_images_cuthill/` + `<Image_filename_png>` is the filepath for the processed dorsal image
143
  * `subset`: whether this is part of the training or test set (`train` or `test`)
144
  * `filepath`: the filepath for the train or test image
145
 
146
+ [Acuity_Curated_GoldStandard_Hoyal_Cuthill.csv]() also has `Image_filename_png` and `subset`, but `subset` references the bird and butterfly acuity training and test sets. Additionally, it has columns:
147
+ * `bird_filepath`: the filepath for the bird acuity version of the image
148
+ * `butterfly_filepath`: the filepath for the butterfly acuity version of the image
149
 
150
 
151
  ### Data Splits
152
 
153
+ There are 250 images in each training set and 70 in each test set.
154
+
155
+ RGB training images are in `train` folder and testing are in `test`.
156
+
157
+ For bird and butterfly acuities, their respective training and test images are in the `train_bird` (`train_butterfly`) and `test_bird` (`test_butterfly`) folders.
158
+
159
+ All of these folders are further subdivided by the subspecies. Filepaths to access these images are provided in [Train_Test_Curated_GoldStandard_Hoyal_Cuthill.csv]() and [Acuity_Curated_GoldStandard_Hoyal_Cuthill.csv](), respectively.
160
+
161
 
162
  ## Dataset Creation
163
 
 
172
 
173
  [More Information Needed]
174
 
175
+ The original data has some misclassified species/subspecies and some localities were outside the known range of the butterflies. Furthermore, the bird and butterfly acuities were not part of the original dataset and provide another level of analysis.
176
+
177
  ### Source Data
178
 
179
  Cuthill, et. al. [doi:10.5061/dryad.2hp1978](https://doi.org/10.5061/dryad.2hp1978).
 
198
 
199
  ### Personal and Sensitive Information
200
 
201
+ None
202
 
203
  ## Considerations for Using the Data
204
 
 
212
 
213
  ### Other Known Limitations
214
 
215
+ * No genetic data available.
216
 
217
+ * Non-uniform distribution of subspecies (imbalanced).
218
 
219
 
220
  ## Additional Information
221
 
222
  ### Dataset Curators
223
 
224
+ * Krzysztof Kozak (University of California Berkeley) - ORCID: 0000-0001-8980-3173
225
 
226
+ * Christopher Lawrence (Princeton University) - ORCID: 0000-0002-3846-5968
227
 
228
+ * James Mallet (Harvard University) - ORCID: 0000-0002-3370-0367
229
 
230
+ * Owen McMillan (Smithsonian Tropical Research Institute) - ORCID: 0000-0003-2805-2745
231
 
232
+ * David Carlyn (The Ohio State University) - ORCID: 0000-0002-8323-0359
233
 
234
+ * Mohannad Elhamod (Virginia Tech) - ORCID: 0000-0002-2383-947X
235
 
236
 
237
  ### Licensing Information