Update README.md

README.md

@@ -1,3 +1,245 @@
----
-license: mit
----
+---
+license: cc0-1.0
+language:
+- en
+tags:
+- biology
+- image
+- animals
+- zebras
+- giraffes
+- Przewalski
+- CV
+- drone
+- autonomy
+- imageomics
+size_categories:
+- n<1K
+---
+
+<!--
+
+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://docs.google.com/document/d/1SlITG-r7kdJB6C8f4FCJ9Z7o7ccwldZoSRJKjhRAWVA/edit#heading=h.c1sxg0wsiqru) 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:
+|![Figure #](https://huggingface.co/imageomics/<data-repo>/resolve/main/<filename>)|
+|:--|
+|**Figure #.** [Image of <>](https://huggingface.co/imageomics/<data-repo>/raw/main/<filename>) <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 wildwingdeployment
+
+<!-- Provide a quick summary of what the data is or can be used for. --> 
+Video, telemetry, and autonomous navigation traces from WildWing unmanned aerial system (UAS) deployment at The Wilds in July 2024.
+
+## Dataset Description
+
+<!-- Provide the basic links for the dataset. -->
+<!--
+- **Homepage:** 
+-->
+- **Repository:** https://github.com/Imageomics/wildwing
+<!--
+- **Paper:** 
+- **Leaderboard:**
+- -->
+  
+- **Point of Contact:** Jenna Kline; kline dot 377 @ osu dot edu
+
+### Dataset Summary
+
+<!-- Provide a longer summary of what this data is. -->
+
+<!--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).-->
+
+<!--
+### Supported Tasks and Leaderboards
+[More Information Needed]
+-->
+### Languages
+english
+
+## Dataset Structure
+
+<!-- Provide format of the dataset, ex:
+
+```
+/dataset/
+    Folder_1/
+        File_1
+        File_2
+        ...
+        File_n
+    Folder_2/
+        File_1
+        File_2
+        ...
+        File_n
+    ...
+    Folder_N/
+        File_1
+        File_2
+        ...
+        File_n
+    metadata.csv
+```
+
+-->
+```
+/wildwingdeployment/
+    species_MMDDYY_HHMMSS/
+        frames/
+            20.jpg
+            ...
+            n.jpg
+        telemetry_log.csv
+        video.MP4
+    ...
+    species_MMDDYY_HHMMSS/
+        frames/
+            20.jpg
+            ...
+            n.jpg
+        telemetry_log.csv
+        video.MP4
+```    
+        
+
+### Data Instances
+
+<!--
+Describe data files
+-->
+The data files contain telemetry logs, videos, and a frame folder containing jpgs. 
+- Telemetry log (CSV): location and status of the drone
+- Frame (JPG): Frame from video stream analyzed with YOLO to inform the commands sent to the drone
+- Video (MP4): video recorded by the drone during the mission
+
+### Data Fields
+[More Information Needed]
+<!--
+Describe the types of the data files or the columns in a CSV with metadata.
+-->
+Telemetry logs
+  - timestamp (YYYY-MM-DD HH:MM:SS)
+  - location of the drone during the mission (GPS, altitude)
+  - the commands sent to the drone (move_x, move_y, move_z in meters)
+  - the frame number sensed at that timestamp
+
+Note on altitude: The altitude recorded in feet (z column) is not accurate.
+
+<!--
+### Data Splits
+[More Information Needed]
+<!--
+Give your train-test splits for benchmarking
+-->
+
+## Dataset Creation
+
+### Curation Rationale
+Data gathered to test the WildWing autonomous UAS system, designed to collect animal behavior video data.
+
+<!--
+### Source Data
+
+#### Initial Data Collection and Normalization
+[More Information Needed]
+
+#### Who are the source language producers?
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+[More Information Needed]
+
+#### Who are the annotators?
+[More Information Needed]
+-->
+### Personal and Sensitive Information
+This dataset contains endangered species: Przewalski's horses and Grevy's zebras. The dataset also includes clips of people in vehicles.
+
+<!-- For instance, if your data includes people or endangered species. -->
+<!--
+## Considerations for Using the Data
+### Social Impact of Dataset
+[More Information Needed]
+
+### Discussion of Biases
+[More Information Needed]
+
+### Other Known Limitations
+[More Information Needed]
+
+<!-- For instance, if your data exhibits a long-tailed distribution (and why). -->
+
+## Additional Information
+
+### Dataset Curators
+Jenna Kline
+
+### Licensing Information
+Creative Commons Zero 1.0 universal
+
+### Citation Information
+
+<!--
+If you want to include BibTex, replace "<>"s with your info 
+-for an associated paper:
+```
+@article{<ref_code>,
+  title    = {<title>},
+  author   = {<author1 and author2>},
+  journal  = {<journal_name>},
+  year     =  <year>,
+  url      = {<DOI_URL>},
+  doi      = {<DOI>}
+}
+```
+-just for data:
+-->
+```
+@misc{<Kline2024wildwingdeployment>,
+  author = {Jenna Kline},
+  title = {WildWing Deployment Dataset},
+  year = {2024},
+  url = {https://huggingface.co/datasets/imageomics/wildwingdeployment},
+  doi = {<doi once generated>},
+  publisher = {Hugging Face}
+}
+```
+
+<!---
+If the data is modified from another source, add the following. 
+
+Please be sure to also cite the original data source:
+<citation>
+-->
+
+
+### Contributions
+
+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.
+
+<!-- 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. -->
+
+[The Wilds](https://www.thewilds.org/animals) is one of the largest conservation centers in the world, located in Cumberland, OH.