Initialize README

README.md

@@ -0,0 +1,305 @@
+---
+#license: ??
+language:
+- en
+pretty_name: Beetlepalooza Dataset
+task_categories:
+- image-classification 
+- image-segmentation
+tags:
+- biology
+- image
+- animals
+- CV
+- beetles
+- elytra
+- elytra width
+- elytra length
+- size
+size_categories: 
+- n<1K
+- 10K<n<100K
+configs:
+- config_name: group_images
+  data_files:
+  - "BeetleMeasurements.csv"
+  - "group_images/*.jpg"
+- config_name: individual_images
+  data_files:
+  - "individual_metadata.csv"
+  - "individual_images/*.jpg"
+---
+
+<!--
+
+NOTE: Add more tags (your particular animal, type of model and use-case, etc.).
+
+See more options for the above information by clicking "edit dataset card" on your repo.
+
+Fill in as much information as you can at each location that says "More information needed".
+-->
+
+<!--
+Image with caption (jpg or png):
+|![Figure #](https://huggingface.co/datasets/imageomics/<data-repo>/resolve/main/<filepath>)|
+|:--|
+|**Figure #.** [Image of <>](https://huggingface.co/datasets/imageomics/<data-repo>/raw/main/<filepath>) <caption description>.|
+-->
+
+<!--
+Notes on styling:
+
+To render LaTex in your README, wrap the code in `\\(` and `\\)`. Example: \\(\frac{1}{2}\\)
+
+Escape underscores ("_") with a "\". Example: image\_RGB
+-->
+
+# Dataset Card for Beetlepalooza Dataset
+
+<!-- Provide a quick summary of what the dataset is or can be used for. --> 
+
+## Dataset Details
+
+### Dataset Description
+
+- **Curated by:** list curators (authors for _data_ citation, moved up)
+<!-- Provide the basic links for the dataset. These will show up on the sidebar to the right of your dataset card ("Curated by" too). -->
+- **Homepage:** 
+- **Repository:** [related project repo]
+- **Paper:** 
+
+
+<!-- Provide a longer summary of what this dataset is. -->
+[More Information Needed]
+
+<!--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), and further altered to suit Imageomics Institute needs.-->
+
+
+### Supported Tasks and Leaderboards
+[More Information Needed]
+
+<!-- Provide benchmarking results -->
+
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+
+In `group_images` we have 577 images of multiple beetles in a reasonably regular pattern (see sample image below). Each of these images contains a centimeter-based scalebar and a barcode representing the sample (collection of beetles in the image). Each row in `BeetleMeasurements.csv` corresponds to a measurement of the elytra (length or width) of an individual beetle.
+
+The `individual_images` directory contains images of each individual segmented from the group images. These connect back to their group image based on the `individualID`.
+
+
+```
+/dataset/
+    group_images/
+        <pictureID 1>.png
+        <pictureID 2>.png
+        ...
+        <pictureID 577>.png
+    individual_images/
+        <individualID 1>.png
+        <individualID 2>.png
+        ...
+        <individualID n>.png
+    BeetleMeasurements.csv
+    individual_metadata.csv
+```
+
+
+
+### Data Instances
+[More Information Needed]
+
+<!--
+Describe data files
+
+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>.
+-->
+
+### Data Fields
+[More Information Needed]
+
+**BeetleMeasurements.csv**:
+  - `PictureID`: Name of the image (`<sample-barcode>.jpg`, though sometimes it's `<NEON_sampleID_>`.jpg). Unique identifier for the 577 _group_ images, not for dataset. There are 11,104 individual beetles?
+  - `scalebar`: Pixel coordinates of the ruler/scalebar in the image.
+  - `scale_dist_pix`: Integer. The length in pixels of the scalebar.
+  - `individual`: Integer. The beetle in the image to whom the measurements refer. Awaiting confirmation of how they are counted.
+  - `structure`: Whether the measurement applies to the length or width of the elytra (`ElytraLength` or `ElytraWidth`, respectively).
+  - `lyingstraight`: Whether or not the beetle is "straight" in the image (`Yes` or `No`). Further guidance on this term's meaning would be helpful.
+  - `coords_pix`: Pixel coordinates of the line marking the length or width of the elytra (green or purple --confirm which is which). Note that the lines are more than one pixel wide, which is why these coordinates form a rectangle.
+  - `dist_pix`: Float. The length or width of the elytra (indicated by `structure`) as measured in pixels.
+  - `dist_cm`: Float. The length or width of the elytra (indicated by `structure`) as measured in centimeters using the scalebar (the red line in the reference image denotes the pixel count for 1cm).
+  - `scientificName`: Scientific name of the specimen (`<Genus> <species>`). There are 85 different species among 36 genera.
+  - `siteID`: String. Identifier for the site from which the specimens were collected. There 30 different site IDs.
+  - `field_site_name`: Name of site from which the specimens were collected. There are 43 different field site names.
+  - `plotID`: Identifier for the plot from which the specimens were collected (`<siteID>_<plot number>`). There are 144 different plots from which specimens were collected.
+  - `user_name`: Name of person inputting the information? (`<first><Last>`) or just their username in the system? Only 3 of them. --looks like username
+  - `workflow_id`: Integer identifier for the workflow used...?? There are 5.
+  - `genus`: Genus of the individual (generated by taking the first word in the `scientificName`).
+  - `individualID`: Unique identifier for the beetles (based on the assumed uniqueness of the `PictureID`, generated from `PictureID` (minus the `.jpg`) plus `_<individual>`.
+  - `file_name`: Relative path to image from the root of the directory (`<group_images>/<pictureID>.jpg`); allows for image to be displayed in the dataset viewer alongside its associated metadata.
+
+
+**TODO:* Make metadata file for viewer once we have segmented images too:
+**individual_metadata.csv**:
+  - `individualID`: ID of beetle in the individual image (matches `individualID` in `BeetleMeasurements.csv`). This is a unique identifier for this CSV.
+  - `pictureID`: Name of the group image (`<sample-barcode>.jpg`, though sometimes it's `<NEON_sampleID_>`.jpg). Unique identifier for the 577 _group_ images, not for dataset. (Matches `pictureID` in `BeetleMeasurements.csv`.)
+  - `scientificName`: Scientific name of the specimen (`<Genus> <species>`). There are 85 different species among 36 genera.
+  - `elytraLength`: Length of the elytra in centimeters.
+  - `elytraWidth`: Width of the elytra in centimeters.
+  - `file_name`: Relative path to image from the root of the directory (`<individual_images>/<individualID>.jpg`); allows for image to be displayed in the dataset viewer alongside its associated metadata.
+
+
+### Data Splits
+[More Information Needed]
+<!--
+Give your train-test splits for benchmarking; could be as simple as "split is indicated by the `split` column in the metadata file: `train`, `val`, or `test`." Or perhaps this is just the training dataset and other datasets were used for testing (you may indicate which were used).
+-->
+
+## Dataset Creation
+
+### Curation Rationale
+[More Information Needed]
+<!-- Motivation for the creation of this dataset. For instance, what you intended to study and why that required curation of a new dataset (or if it's newly collected data and why the data was collected (intended use)), etc. -->
+
+This dataset was curated for use at [BeetlePalooza 2024](https://github.com/Imageomics/BeetlePalooza-2024/wiki) to help drive scientific discovery through machine learning and computer vision.
+
+
+### Source Data
+
+<!-- This section describes the source data (e.g., news text and headlines, social media posts, translated sentences, ...). As well as an original source it was created from (e.g., sampling from Zenodo records, compiling images from different aggregators, etc.) -->
+
+The specimens come from [NEON sites](https://www.neonscience.org/), as indicated in the `BeetleMeasurements` CSV.
+
+#### Data Collection and Processing
+[More Information Needed]
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, re-sizing of images, tools and libraries used, etc. 
+This is what _you_ did to it following collection from the original source; it will be overall processing if you collected the data initially.
+-->
+
+#### Who are the source data producers?
+[More Information Needed]
+<!-- This section describes the people or systems who originally created the data.
+
+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.
+ -->
+
+
+### Annotations
+<!-- 
+If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. 
+
+Ex: We standardized the taxonomic labels provided by the various data sources to conform to a uniform 7-rank Linnean structure. (Then, under annotation process, describe how this was done: Our sources used different names for the same kingdom (both _Animalia_ and _Metazoa_), so we chose one for all (_Animalia_). -->
+
+Annotations were completed by 3 individuals (indicated by their NEON system usernames in the `BeetleMeasurements` CSV).
+
+#### Annotation process
+[More Information Needed]
+<!-- This section describes the annotation process such as annotation tools used, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+
+#### Who are the annotators?
+[More Information Needed]
+<!-- This section describes the people or systems who created the annotations. -->
+
+### Personal and Sensitive Information
+[More Information Needed]
+<!-- 
+For instance, if your data includes people or endangered species. -->
+
+
+## Considerations for Using the Data
+[More Information Needed]
+<!--
+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".
+-->
+
+### Bias, Risks, and Limitations
+[More Information Needed]
+<!-- This section is meant to convey both technical and sociotechnical limitations. Could also address misuse, malicious use, and uses that the dataset will not work well for.-->
+
+<!-- For instance, if your data exhibits a long-tailed distribution (and why). -->
+
+### Recommendations
+[More Information Needed]
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+## Licensing Information
+[More Information Needed]
+
+<!-- See notes at top of file about selecting a license. 
+If you choose CC0: This dataset is dedicated to the public domain for the benefit of scientific pursuits. We ask that you cite the dataset and journal paper using the below citations if you make use of it in your research.
+
+Be sure to note different licensing of images if they have a different license from the compilation.
+ex: 
+The data (images and text) contain a variety of licensing restrictions mostly within the CC family. 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 licenses in the license file).
+
+EOL images contain a variety of licenses ranging from [CC0](https://creativecommons.org/publicdomain/zero/1.0/) to [CC BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+For license and citation information by image, see our [license file](https://huggingface.co/datasets/imageomics/treeoflife-10m/blob/main/metadata/licenses.csv).
+
+This dataset (the compilation) has been marked as dedicated to the public domain by applying the [CC0 Public Domain Waiver](https://creativecommons.org/publicdomain/zero/1.0/). However, images may be licensed under different terms (as noted above).
+-->
+
+## Citation
+[More Information Needed]
+
+**BibTeX:**
+<!--
+If you want to include BibTex, replace "<>"s with your info 
+
+**Data**
+```
+@misc{<ref_code>,
+  author = {<author1 and author2>},
+  title = {<title>},
+  year = {<year>},
+  url = {https://huggingface.co/datasets/imageomics/<dataset_name>},
+  doi = {<doi once generated>},
+  publisher = {Hugging Face}
+}
+```
+
+-for an associated paper:
+**Paper**
+```
+@article{<ref_code>,
+  title    = {<title>},
+  author   = {<author1 and author2>},
+  journal  = {<journal_name>},
+  year     =  <year>,
+  url      = {<DOI_URL>},
+  doi      = {<DOI>}
+}
+```
+-->
+
+<!---
+If the data is modified from another source, add the following. 
+
+Please be sure to also cite the original data source(s):
+<citation>
+-->
+
+
+## Acknowledgements
+
+The National Ecological Observatory Network is a program sponsored by the National Science Foundation and operated under cooperative agreement by Battelle. This material uses specimens and/or samples collected as part of the NEON Program. Additionally, this material is based upon work supported by the National Science Foundation under [Award No. 2118240](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2118240) ([Imageomics](https://imageomics.org): A New Frontier of Biological Information Powered by Knowledge-Guided Machine Learning), and under Award Numbers [2301322](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2301322&HistoricalAwards=false) and [2242803]() and the USDA National Institute of Food and Agriculture, Hatch Project [Number ME0-22425]() through the Maine Agricultural and Forest Experiment Station. 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.
+
+
+## Glossary 
+
+<!-- [optional] If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+
+## More Information 
+
+<!-- [optional] Any other relevant information that doesn't fit elsewhere. -->
+
+## Dataset Card Authors 
+
+[More Information Needed]
+
+## Dataset Card Contact
+
+[More Information Needed--optional]
+<!-- Could include who to contact with questions, but this is also what the "Discussions" tab is for. -->
+