Initial setup of readme

README.md

@@ -1,3 +1,175 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-4.0
+task_categories:
+- image-classification
+- image-segmentation
+- image-feature-extraction
+language:
+- en
+tags:
+- biology
+- beetles
+pretty_name: Wilds-Beetles
+size_categories:
+- 1K<n<10K
+---
+
+<!--
+
+NOTE: Add more tags (your particular animal, type of model and use-case, etc.).
+
+As with your GitHub Project repo, it is important to choose an appropriate license for your dataset. The default license is [CC0](https://creativecommons.org/publicdomain/zero/1.0/) (public domain dedication, see [Dryad's explanation of why to use CC0](https://blog.datadryad.org/2023/05/30/good-data-practices-removing-barriers-to-data-reuse-with-cc0-licensing/)). Alongside the appropriate stakeholders (eg., your PI, co-authors), select a license that is [Open Source Initiative](https://opensource.org/licenses) (OSI) compliant.
+For more information on how to choose a license and why it matters, see [Choose A License](https://choosealicense.com) and [A Quick Guide to Software Licensing for the Scientist-Programmer](https://doi.org/10.1371/journal.pcbi.1002598) by A. Morin, et al.
+See the [Imageomics policy for licensing](https://imageomics.github.io/Imageomics-guide/wiki-guide/Digital-products-release-licensing-policy/) for more information.
+
+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 Wilds-Beetles
+
+This dataset includes 3,000+ hand taken images of approximately 300 beetles at the Wilds in July 2024. Aim is to succesfully build a model capable 
+of idnetifying unique beetles based on spot patterns
+
+## Dataset Details
+
+### Dataset Description
+
+- **Curated by:** Michael Silagy
+- **Homepage:** 
+- **Repository:** [related project repo]
+- **Paper:** 
+
+## 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. -->
+
+/dataset/
+    <img_id 1>.png
+    <img_id 2>.png
+    ...
+    <img_id n>.png
+    beetle_labels.csv <!-- maps image id to beetle id -->
+
+
+## Data files
+
+All images are named <img_id>.png. They are 1024 x 1024. Images are mapped to beetles in beetle_labels.csv
+
+**beetle_labels.csv**:
+  - `fname`: name for a given image. Ex IMG_0004. 
+  - `viewpoint`: Portion of beetle visible to camera. [Top, back, head, left_side, right_side]
+  - 'beetle_id': The beetle which the image is taken of
+  - 'file_name': Full file name, which is fname + .JPEG i.e IMG_0004.JPEG
+  - `species`: Species of the specimen in the image. For this dataset, there is only one. [burying_beetle]
+  - `file_path`: Relative path to image from the root of the directory (`<dataset>/<species>/<img_id>.jpeg`); 
+-->
+
+### Data Splits
+[Work In Progress]
+<!--
+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).
+-->
+
+
+### Curation Rationale
+The wilds releases hundreds of beetles each year, some of which are ineviably lost track of or are hard to indentify due to manual tagging, which can be lost or damaged
+The ideal engame is to create a model or AI capable of identifying unique beetles based only on spot patterns using a single image, and having that model
+quickly identify a beetle given a new image once captured. This could eventually be done on edge (i.e on the same phone the image was taken on)
+
+#### Data Collection and Processing
+Data was mnaully collected over a period of several weeks. Beetles were indivudally handled by Michael and photos were taken at various viewpoints
+
+
+### Bias, Risks, and Limitations
+There is no set standard for how many images of a givne beetle were taken, although I tried to capture 5+ covering several angles for each beetle.
+Some beetles were more cooperative than others, sometimes only top angle was succesfully captured without getting hands in image (i.e beetle would not sit still)
+
+
+## Licensing Information
+
+CCO: 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.
+
+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
+
+This work was supported by the [Imageomics Institute](https://imageomics.org), which 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.
+
+<!-- You may also want to credit the source of your data, i.e., if you went to a museum or nature preserve to collect it. -->
+
+## 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 
+
+@mdsilly
+
+## Dataset Card Contact
+
+[More Information Needed--optional]
+<!-- Could include who to contact with questions, but this is also what the "Discussions" tab is for. -->
+---