egrace479 commited on
Commit
d5c169e
·
verified ·
1 Parent(s): 842dede

fix formatting issues

Browse files
Files changed (1) hide show
  1. README.md +17 -28
README.md CHANGED
@@ -67,15 +67,10 @@ Describe data files
67
  Ex: All images are named <img_id>.png, each within a folder named for the species. They are 1024 x 1024, and the color has been standardized using <link to color standardization package>.
68
  -->
69
 
70
-
71
- [More Information Needed]
72
-
73
  * **Type:** JPG
74
- <!-- PNG if we include the smaller images
75
- * **Size (x pixels by y pixels):** Not yet known (downsized are 256 x 256) -->
76
  * **Background (color or none):** Sometimes gray sometimes white
77
  * **Fit in frame:** tight
78
- * **Ruler or Scale:** Do not think so
79
  * **Color:** 5x6 Color checker
80
 
81
  Potential for future addition of genetic sequencing data.
@@ -88,18 +83,14 @@ The CSV also includes labels regarding the quality of the specimen: `damaged`, `
88
 
89
  ### Data Fields
90
 
91
- [More Information Needed]
92
-
93
- Suggested columns to keep:
94
-
95
  **metadata.csv:** minimal data record for the images; this is a subset of all the information potentially available for each image since curation of this dataset is still ongoing. This also means that there are some duplicative columns (e.g., there are multiple NCSU and STRI IDs).
96
  - **label:** indicates quality of specimen, either `damaged`, `dorsal`, or `incomplete`.
97
  - **img_name_no_ext:** `FileName` without the type extension.
98
- source_url, --not actually a URL. it's a box location, with the folder, seems like something to potentially remove
99
- source_dataset -- holdover from separating them out, can remove
100
- - **FileName:** filename given to image (with extension, e.g., ".JPG"). Often (??) `<NCSU_id>_D.JPG`.
101
- - **Folder:** folder in which images or a record is kept, seems to be date followed by number; part of the "source_url"??
102
- - **Box:** Box in which specimen was kept? ("Box 11" or "Box 10").
103
  - **Genus:** genus of the specimen; primarily "Heliconius", but also "Junonia", "Eueides", "Neruda", or "Dryas". Labeled for all images.
104
  - **species:** species of the specimen; 11 unique species, but mostly "erato" and "melpomene". Labeled for all but six of the images.
105
  - **subspecies:** subspecies of the specimen if provided, or parent subspecies if hybrid. Labeled for 168 images.
@@ -108,12 +99,13 @@ source_dataset -- holdover from separating them out, can remove
108
  - **id uncertain:** indicates uncertainty in the taxonomic identity of the specimen? -- 11 images, but there is another image with a question mark in the subspecies name.
109
  - **sex:** sex of the specimen ("male" or "female", one instance of "?", most labeled).
110
 
111
- MULTIPLE IDS -- keep for alignment and standardization later
112
- NCSU_id, ID from NCSU? Did all values have this or is it just NCSU prefix?
113
- NCSU #, --relation to NCSU ID and STRI ID?
114
- stri_id, --relation to NCSU id?
115
- STRI ID, -- relation to other versions above?
116
- Other ID,-- relation to other versions above?
 
117
 
118
 
119
  - **Date Collected:** date specimen was collected? Seem to be mostly DD-MM-YY, but not consistent.
@@ -135,7 +127,7 @@ These images were selected and labeled to use in training the [Imageomics/butter
135
 
136
  ### Source Data
137
 
138
- Images are of specimens collected by the [Smithsonian Tropical Research Institute](https://stri.si.edu/) and photographs of this subset were taken by Daniel Romero, Carlos Arias, and other members of the Owen McMilan Lab at the Smithsonian Tropical Research Institute Gamboa Station.
139
  <!-- images taken by Christopher Lawrence have not been added yet, curation ongoing -->
140
 
141
  #### Data Collection and Processing
@@ -148,12 +140,11 @@ This is what _you_ did to it following collection from the original source; it w
148
  -->
149
 
150
  #### Who are the source data producers?
151
- [More Information Needed]
152
  <!-- This section describes the people or systems who originally created the data.
153
 
154
  Ex: This dataset is a collection of images taken of the butterfly collection housed at the Ohio State University Museum of Biological Diversity. The associated labels and metadata are the information provided with the collection from biologists that study butterflies and supplied the specimens to the museum.
155
  -->
156
- The dataset is a collection of images taken of the McMilan Lab's collection of butterfly samples obtained from field collection surveys and several raised in captivity for genetic and other studies.
157
 
158
  ### Annotations
159
  There are several annotations in this data that are not standard and are very specific. Further annotation is needed. In general, taxonomic information down to the species and subspecies name is provided but is not always correct and needs double checking at this moment.
@@ -162,9 +153,9 @@ There are several annotations in this data that are not standard and are very sp
162
  Damage annotations were completed by Michelle Ramirez for training the [Imageomics/butterfly_detection_yolo](https://huggingface.co/imageomics/butterfly_detection_yolo) model she created.
163
 
164
  #### Who are the annotators?
165
- [More Information Needed]
166
  <!-- This section describes the people or systems who created the annotations. -->
167
- Annotation data (other than the damage labels) was provided by the McMilan Lab.
168
 
169
  ### Personal and Sensitive Information
170
  [More Information Needed]
@@ -173,7 +164,6 @@ For instance, if your data includes people or endangered species. -->
173
 
174
 
175
  ## Considerations for Using the Data
176
- [More Information Needed]
177
  <!--
178
  Things to consider while working with the dataset. For instance, maybe there are hybrids and they are labeled in the `hybrid_stat` column, so to get a subset without hybrids, subset to all instances in the metadata file such that `hybrid_stat` is _not_ "hybrid".
179
  -->
@@ -182,7 +172,6 @@ Things to consider while working with the dataset. For instance, maybe there are
182
  This is a small sample of minimally curated butterfly images intended only for wing segmentation and damage detection. It is **not** intended for species classification.
183
 
184
  ### Recommendations
185
- [More Information Needed]
186
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
187
 
188
  This is not a complete dataset, nor is it curated for greater use. The purpose of this dataset is to provide the 207 image sample used as part of a larger training set for the [Imageomics/butterfly_detection_yolo](https://huggingface.co/imageomics/butterfly_detection_yolo) model. More information on the full project can be found in the [GitHub repository](https://github.com/Imageomics/wing-segmentation).
 
67
  Ex: All images are named <img_id>.png, each within a folder named for the species. They are 1024 x 1024, and the color has been standardized using <link to color standardization package>.
68
  -->
69
 
 
 
 
70
  * **Type:** JPG
 
 
71
  * **Background (color or none):** Sometimes gray sometimes white
72
  * **Fit in frame:** tight
73
+ * **Ruler or Scale:** No
74
  * **Color:** 5x6 Color checker
75
 
76
  Potential for future addition of genetic sequencing data.
 
83
 
84
  ### Data Fields
85
 
 
 
 
 
86
  **metadata.csv:** minimal data record for the images; this is a subset of all the information potentially available for each image since curation of this dataset is still ongoing. This also means that there are some duplicative columns (e.g., there are multiple NCSU and STRI IDs).
87
  - **label:** indicates quality of specimen, either `damaged`, `dorsal`, or `incomplete`.
88
  - **img_name_no_ext:** `FileName` without the type extension.
89
+ - **source_url:** not actually a URL, but a box location, with the folder.
90
+ - **source_dataset:** All `STRI`, holdover from combination into larger dataset.
91
+ - **FileName:** filename given to image (with extension, e.g., ".JPG"). Often `<NCSU_id>_D.JPG`.
92
+ - **Folder:** folder in which images or a record is kept, seems to be date followed by number; part of the "source_url".
93
+ - **Box:** Box in which specimen was kept ("Box 11" or "Box 10").
94
  - **Genus:** genus of the specimen; primarily "Heliconius", but also "Junonia", "Eueides", "Neruda", or "Dryas". Labeled for all images.
95
  - **species:** species of the specimen; 11 unique species, but mostly "erato" and "melpomene". Labeled for all but six of the images.
96
  - **subspecies:** subspecies of the specimen if provided, or parent subspecies if hybrid. Labeled for 168 images.
 
99
  - **id uncertain:** indicates uncertainty in the taxonomic identity of the specimen? -- 11 images, but there is another image with a question mark in the subspecies name.
100
  - **sex:** sex of the specimen ("male" or "female", one instance of "?", most labeled).
101
 
102
+ **Columns maintained for future clean-up and recombination**
103
+ - `MULTIPLE IDS` -- keep for alignment and standardization later
104
+ - `NCSU_id`, ID from NCSU? Did all values have this or is it just NCSU prefix?
105
+ - `NCSU_num` (previously `NCSU #`) --relation to NCSU ID and STRI ID?
106
+ - `stri_id`, --relation to NCSU id?
107
+ - `STRI ID`, -- relation to other versions above?
108
+ - `Other ID`,-- relation to other versions above?
109
 
110
 
111
  - **Date Collected:** date specimen was collected? Seem to be mostly DD-MM-YY, but not consistent.
 
127
 
128
  ### Source Data
129
 
130
+ Images are of specimens collected by the [Smithsonian Tropical Research Institute](https://stri.si.edu/) and photographs of this subset were taken by Daniel Romero, Carlos Arias, and other members of the Owen McMillan Lab at the Smithsonian Tropical Research Institute Gamboa Station.
131
  <!-- images taken by Christopher Lawrence have not been added yet, curation ongoing -->
132
 
133
  #### Data Collection and Processing
 
140
  -->
141
 
142
  #### Who are the source data producers?
 
143
  <!-- This section describes the people or systems who originally created the data.
144
 
145
  Ex: This dataset is a collection of images taken of the butterfly collection housed at the Ohio State University Museum of Biological Diversity. The associated labels and metadata are the information provided with the collection from biologists that study butterflies and supplied the specimens to the museum.
146
  -->
147
+ The dataset is a collection of images taken of the McMillan Lab's collection of butterfly samples obtained from field collection surveys and several raised in captivity for genetic and other studies.
148
 
149
  ### Annotations
150
  There are several annotations in this data that are not standard and are very specific. Further annotation is needed. In general, taxonomic information down to the species and subspecies name is provided but is not always correct and needs double checking at this moment.
 
153
  Damage annotations were completed by Michelle Ramirez for training the [Imageomics/butterfly_detection_yolo](https://huggingface.co/imageomics/butterfly_detection_yolo) model she created.
154
 
155
  #### Who are the annotators?
156
+
157
  <!-- This section describes the people or systems who created the annotations. -->
158
+ Annotation data (other than the damage labels) was provided by the McMillan Lab.
159
 
160
  ### Personal and Sensitive Information
161
  [More Information Needed]
 
164
 
165
 
166
  ## Considerations for Using the Data
 
167
  <!--
168
  Things to consider while working with the dataset. For instance, maybe there are hybrids and they are labeled in the `hybrid_stat` column, so to get a subset without hybrids, subset to all instances in the metadata file such that `hybrid_stat` is _not_ "hybrid".
169
  -->
 
172
  This is a small sample of minimally curated butterfly images intended only for wing segmentation and damage detection. It is **not** intended for species classification.
173
 
174
  ### Recommendations
 
175
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
176
 
177
  This is not a complete dataset, nor is it curated for greater use. The purpose of this dataset is to provide the 207 image sample used as part of a larger training set for the [Imageomics/butterfly_detection_yolo](https://huggingface.co/imageomics/butterfly_detection_yolo) model. More information on the full project can be found in the [GitHub repository](https://github.com/Imageomics/wing-segmentation).