C-G-L egrace479 commited on
Commit
7f9467a
1 Parent(s): 6ef14cc

Update README (#4)

Browse files

- Update README (432184c9487f19f069ebbfaa7820191c22015e8b)


Co-authored-by: Elizabeth Campolongo <egrace479@users.noreply.huggingface.co>

Files changed (1) hide show
  1. README.md +23 -17
README.md CHANGED
@@ -17,7 +17,7 @@ tags:
17
  - cross types
18
  - wild
19
  - lab-bred
20
- pretty_name: Jiggins Heliconius Collection
21
  size_categories:
22
  - 10K<n<100K
23
  language:
@@ -26,17 +26,17 @@ configs:
26
  - config_name: full_master
27
  data_files:
28
  - split: train
29
- path: "Jiggins_Zenodo_Img_Master.csv"
30
  - config_name: heliconius
31
  data_files:
32
  - split: train
33
- path: "Jiggins_Heliconius_Master.csv"
34
  - config_name: dorsal
35
  data_files:
36
  - split: train
37
- path: "Jiggins_Zenodo_dorsal_Img_Master.csv"
38
  ---
39
- # Dataset Card for Jiggins Heliconius Collection
40
 
41
  ## Dataset Description
42
 
@@ -55,9 +55,10 @@ This subset contains approximately 36,189 RGB images of 11,962 specimens (29,134
55
 
56
  Most images were photographed with a DSLR camera with a 100 mm macro-lens in standardized conditions.
57
  More information can be found at the individual Zenodo record pages.
58
- Images and full records with data are stored in the [EarthCape database](https://heliconius.ecdb.io/default.aspx) and on [Zenodo](https://zenodo.org/communities/butterfly?q=&l=list&p=1&s=10&sort=newest) (across 29 records from the Butterfly Genetics Group).
 
59
 
60
- Both dorsal and ventral images available. Contains both whole butterfly, and 4 wings separate. Large variation in image content.
61
 
62
  <!---
63
  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).
@@ -82,7 +83,7 @@ English, Latin
82
 
83
  **Notes:**
84
  - The notebooks that generated these files and stats are included in the `notebooks` folder, their only requirement is `pandas`.
85
- - The [original Jiggins Zenodo Master file](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/Jiggins_Zenodo_Master.csv) was compiled from the CSVs provided with the included Zenodo records from the Butterfly Genetics Group. Christopher Lawrence selected which of these provided columns to include. Further processing and standardization (all documented in the Jupyter Notebooks) was performed by Elizabeth Campolongo.
86
  - Taxonomic information for records [5526257](https://zenodo.org/record/5526257), [2554218](https://zenodo.org/record/2554218), and [2555086](https://zenodo.org/record/2555086) was recovered from information on their Zenodo pages, as the provided CSVs did not contain that information.
87
  - Be advised that there may be overlap between images in [record 2548678](https://zenodo.org/records/2548678) and [record 3082688](https://zenodo.org/records/3082688).
88
  - The `scripts` folder has a download and checksum script, their only requirement is `pandas`.
@@ -174,9 +175,9 @@ Additionally, these datasets are prepared in a format that allows for easy integ
174
 
175
  These images are a subset of the [Butterfly Genetics Group's Cambridge butterfly collection](https://zenodo.org/communities/butterfly?q=&f=subject%3ACambridge&l=list&p=1&s=10&sort=newest). This collection of butterfly images comes from the research group of Chris Jiggins at the University of Cambridge derived from almost 20 years of field studies.
176
 
177
- Data is pulled from the Zenodo Records in [`licenses.json`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/licenses.json). This file also contains full citation information for all records.
178
 
179
- The [original Master file](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/Jiggins_Zenodo_Master.csv), created by Christopher Lawrence, was fed into notebook Data-gen-0-1, and further processed in Data-gen-0-2 and Data-gen-0-3. The next data generation step (deduplication by MD5) involved downloading all images in `metadata/Jiggins_Zenodo_Img_Master_3477891Patch.csv` (created in Data-gen-1-1). MD5s of all downloaded images were taken and the results were explored in the EDA-DL series of notebooks; information and conclusions from this EDA are documented in [`README-supplemental`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/README-supplemental.md). The outline described there was then implemented in the [Data-gen-1-2 notebook](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/notebooks/Data-gen-1-2.ipynb), regenerating all current datasets. This notebook also has another round of taxonomic standardization so that all entries labeled only to the genus level are labeled as `<Genus> sp.` in both `Taxonomic_Name` and `species` columns, 4 entries with a non-butterfly genus name were noted and removed, as were 18 entries with `Unknown` as their taxonomic label.
180
 
181
 
182
  #### Initial Data Collection and Annotation
@@ -199,30 +200,35 @@ None
199
  - There are multiple images of the same specimen for many specimens; sometimes this is due to different views (eg., dorsal or ventral side), sometimes it is due to JPG copies of the RAW photos, though it seems it is also sometimes that new photos were taken of the same specimen at a different times.
200
  - The master files contain only images that were determined to be unique (at the pixel level) through MD5 checksum. This does _**not**_ guarantee that there are not images that are cropped copies of other photos. For instance, [record 2553977](https://zenodo.org/records/2553977) has a number of images with `_cut_` in their name, some of which are close-up crops of the butterfly wings (though not all, some are just close-ups of the full butterfly).
201
 
202
- Please see [`README-supplemental.md`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/README-supplemental.md) for more details on the deduplication process and recommendations on how to split this data effectively without data leakage.
203
 
204
 
205
  ## Additional Information
206
 
207
  ### Dataset Curators
208
 
209
- * Christopher Lawrence (Princeton University) - ORCID: 0000-0002-3846-5968
210
  * Chris Jiggins (University of Cambridge) - ORCID: 0000-0002-7809-062X
 
 
211
  * Butterfly Genetics Group (University of Cambridge)
 
 
 
212
  * Elizabeth G. Campolongo (Imageomics Institute, The Ohio State University) - ORCID: 0000-0003-0846-2413
213
 
214
  ### Licensing Information
215
 
216
- The data (images and text) are all licensed under [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/). Each image and text in this dataset is provided under the least restrictive terms allowed by its licensing requirements as provided to us (i.e, we impose no additional restrictions past those specified by this license on the original source files). Modified images are only restricted by this original license.
217
 
218
- Images can be matched to their source record through the `zenodo_link` or `record_number` column in the Master CSVs to the `url` or `record_number` in the [`licenses.json`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/licenses.json) file, respectively.
219
 
220
  ### Citation Information
221
 
222
- Christopher Lawrence, Chris Jiggins, Butterfly Genetics Group (University of Cambridge), Elizabeth G. Campolongo. (2024). Jiggins Heliconius Collection. Hugging Face. https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection.
223
 
224
- If you use this dataset, please cite the original datasets (bibtex citations for all 29 included Zenodo records are in [`jiggins.bib`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/jiggins.bib)) as well as this curated subset.
225
 
226
  ### Contributions
227
 
228
- The [Imageomics Institute](https://imageomics.org) is funded by the US National Science Foundation's Harnessing the Data Revolution (HDR) program under [Award #2118240](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2118240) (Imageomics: A New Frontier of Biological Information Powered by Knowledge-Guided Machine Learning). Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.
 
17
  - cross types
18
  - wild
19
  - lab-bred
20
+ pretty_name: Heliconius Collection (Cambridge Butterfly)
21
  size_categories:
22
  - 10K<n<100K
23
  language:
 
26
  - config_name: full_master
27
  data_files:
28
  - split: train
29
+ path: Jiggins_Zenodo_Img_Master.csv
30
  - config_name: heliconius
31
  data_files:
32
  - split: train
33
+ path: Jiggins_Heliconius_Master.csv
34
  - config_name: dorsal
35
  data_files:
36
  - split: train
37
+ path: Jiggins_Zenodo_dorsal_Img_Master.csv
38
  ---
39
+ # Dataset Card for Heliconius Collection (Cambridge Butterfly)
40
 
41
  ## Dataset Description
42
 
 
55
 
56
  Most images were photographed with a DSLR camera with a 100 mm macro-lens in standardized conditions.
57
  More information can be found at the individual Zenodo record pages.
58
+ Images and full records with data are stored in the [EarthCape database](https://heliconius.ecdb.io/) and on [Zenodo](https://zenodo.org/communities/butterfly?q=&l=list&p=1&s=10&sort=newest) (across 29 records from the Butterfly Genetics Group).
59
+ Please note that the [EarthCape Database](https://heliconius.ecdb.io/Occurrence_ListView) is under continuous development as more specimens are classified, photographed, sequenced, etc. by the Butterfly Genetics Group.
60
 
61
+ Both dorsal and ventral images available. Contains primarily separated wings, with some whole butterfly images. There is variation in image content (whitestandard, background color, etc. based on the needs of the project).
62
 
63
  <!---
64
  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).
 
83
 
84
  **Notes:**
85
  - The notebooks that generated these files and stats are included in the `notebooks` folder, their only requirement is `pandas`.
86
+ - The [original Jiggins Zenodo Master file](https://huggingface.co/datasets/imageomics/Heliconius-Collection_Cambridge-Butterfly/blob/main/metadata/Jiggins_Zenodo_Master.csv) was compiled from the CSVs provided with the included Zenodo records from the Butterfly Genetics Group. Christopher Lawrence selected which of these provided columns to include. Further processing and standardization (all documented in the Jupyter Notebooks) was performed by Elizabeth Campolongo.
87
  - Taxonomic information for records [5526257](https://zenodo.org/record/5526257), [2554218](https://zenodo.org/record/2554218), and [2555086](https://zenodo.org/record/2555086) was recovered from information on their Zenodo pages, as the provided CSVs did not contain that information.
88
  - Be advised that there may be overlap between images in [record 2548678](https://zenodo.org/records/2548678) and [record 3082688](https://zenodo.org/records/3082688).
89
  - The `scripts` folder has a download and checksum script, their only requirement is `pandas`.
 
175
 
176
  These images are a subset of the [Butterfly Genetics Group's Cambridge butterfly collection](https://zenodo.org/communities/butterfly?q=&f=subject%3ACambridge&l=list&p=1&s=10&sort=newest). This collection of butterfly images comes from the research group of Chris Jiggins at the University of Cambridge derived from almost 20 years of field studies.
177
 
178
+ Data is pulled from the Zenodo Records in [`licenses.json`](https://huggingface.co/datasets/imageomics/Heliconius-Collection_Cambridge-Butterfly/blob/main/metadata/licenses.json). This file also contains full citation information for all records.
179
 
180
+ The [original Master file](https://huggingface.co/datasets/imageomics/Heliconius-Collection_Cambridge-Butterfly/blob/main/metadata/Jiggins_Zenodo_Master.csv), created by Christopher Lawrence, was fed into notebook Data-gen-0-1, and further processed in Data-gen-0-2 and Data-gen-0-3. The next data generation step (deduplication by MD5) involved downloading all images in `metadata/Jiggins_Zenodo_Img_Master_3477891Patch.csv` (created in Data-gen-1-1). MD5s of all downloaded images were taken and the results were explored in the EDA-DL series of notebooks; information and conclusions from this EDA are documented in [`README-supplemental`](https://huggingface.co/datasets/imageomics/Heliconius-Collection_Cambridge-Butterfly/blob/main/README-supplemental.md). The outline described there was then implemented in the [Data-gen-1-2 notebook](https://huggingface.co/datasets/imageomics/Heliconius-Collection_Cambridge-Butterfly/blob/main/notebooks/Data-gen-1-2.ipynb), regenerating all current datasets. This notebook also has another round of taxonomic standardization so that all entries labeled only to the genus level are labeled as `<Genus> sp.` in both `Taxonomic_Name` and `species` columns, 4 entries with a non-butterfly genus name were noted and removed, as were 18 entries with `Unknown` as their taxonomic label.
181
 
182
 
183
  #### Initial Data Collection and Annotation
 
200
  - There are multiple images of the same specimen for many specimens; sometimes this is due to different views (eg., dorsal or ventral side), sometimes it is due to JPG copies of the RAW photos, though it seems it is also sometimes that new photos were taken of the same specimen at a different times.
201
  - The master files contain only images that were determined to be unique (at the pixel level) through MD5 checksum. This does _**not**_ guarantee that there are not images that are cropped copies of other photos. For instance, [record 2553977](https://zenodo.org/records/2553977) has a number of images with `_cut_` in their name, some of which are close-up crops of the butterfly wings (though not all, some are just close-ups of the full butterfly).
202
 
203
+ Please see [`README-supplemental.md`](https://huggingface.co/datasets/imageomics/Heliconius-Collection_Cambridge-Butterfly/blob/main/README-supplemental.md) for more details on the deduplication process and recommendations on how to split this data effectively without data leakage.
204
 
205
 
206
  ## Additional Information
207
 
208
  ### Dataset Curators
209
 
210
+ **Original Images:**
211
  * Chris Jiggins (University of Cambridge) - ORCID: 0000-0002-7809-062X
212
+ * Gabriela Montejo-Kovacevich (University of Cambridge)
213
+ * Ian Warren (University of Cambridge)
214
  * Butterfly Genetics Group (University of Cambridge)
215
+
216
+ **This Collection:**
217
+ * Christopher Lawrence (Princeton University) - ORCID: 0000-0002-3846-5968
218
  * Elizabeth G. Campolongo (Imageomics Institute, The Ohio State University) - ORCID: 0000-0003-0846-2413
219
 
220
  ### Licensing Information
221
 
222
+ The data (images and text) are all licensed under [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/). Each image and text in this dataset is provided under the least restrictive terms allowed by its licensing requirements as provided to us (i.e, we impose no additional restrictions past those specified by this license on the original source files).
223
 
224
+ Images can be matched to their source record through the `zenodo_link` or `record_number` column in the Master CSVs to the `url` or `record_number` in the [`licenses.json`](https://huggingface.co/datasets/imageomics/Heliconius-Collection_Cambridge-Butterfly/blob/main/metadata/licenses.json) file, respectively.
225
 
226
  ### Citation Information
227
 
228
+ Christopher Lawrence and Elizabeth G. Campolongo. (2024). Heliconius Collection (Cambridge Butterfly). Hugging Face. https://huggingface.co/datasets/imageomics/Heliconius-Collection_Cambridge-Butterfly.
229
 
230
+ If you use this compilation, please cite the original datasets compiled by the Butterfly Genetics Group at University of Cambridge (bibtex citations for all 29 included Zenodo records are in [`jiggins.bib`](https://huggingface.co/datasets/imageomics/Heliconius-Collection_Cambridge-Butterfly/blob/main/metadata/jiggins.bib)) as well as this curated subset.
231
 
232
  ### Contributions
233
 
234
+ The [Imageomics Institute](https://imageomics.org) is funded by the US National Science Foundation's Harnessing the Data Revolution (HDR) program under [Award #2118240](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2118240) (Imageomics: A New Frontier of Biological Information Powered by Knowledge-Guided Machine Learning). Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.