Update README.md

README.md

@@ -1,32 +1,147 @@
 ---
-dataset_info:
-# The original split contains 30 images of screenshots grabbed from fencing database https://actions.quarte-riposte.com/
-# The images were classified by whether a point had been awarded or not
-# The data was augmented 300 rows by torchvision transforms
-# Google Gemini was used for code debugging only
-  features:
-  - name: image
-    dtype: image
-  - name: label
-    dtype:
-      class_label:
-        names:
-          '0': Resized No Point
-          '1': Resized Point
-  splits:
-  - name: original
-    num_bytes: 2478740.0
-    num_examples: 30
-  - name: augmented
-    num_bytes: 23134922.0
-    num_examples: 330
-  download_size: 25616650
-  dataset_size: 25613662.0
-configs:
-- config_name: default
-  data_files:
-  - split: original
-    path: data/original-*
-  - split: augmented
-    path: data/augmented-*
+# For reference on dataset card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1
+# Doc / guide: https://huggingface.co/docs/hub/datasets-cards
+{{ card_data }}
 ---
+
+# Dataset Card for {{ pretty_name | default("Dataset Name", true) }}
+
+<!-- This dataset has image data of fencing competition, and is meant for classifying whether or not a point has been awarded.
+ -->
+
+{{ dataset_summary | default("This dataset has image data of fencing competition, and is meant for classifying whether or not a point has been awarded.", true) }}
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- The original split contains thirty screenshots retrieved from the source below. 15 images of the original split show frames where a point has not yet been 
+awarded, while 15 show frames where a point has been awarded. The augmented split shows 300 images that have been augmented via torchvision transforms.-->
+
+{{ dataset_description | default("The original split contains thirty screenshots retrieved from https://actions.quarte-riposte.com/. 15 images of the original split show frames where a point has not yet been awarded, while 15 show frames where a point has been awarded. The augmented split shows 300 images that have been augmented via torchvision transforms.", true) }}
+
+- **Curated by:** {{ curators | default("Ethan Kessler", true)}}
+- **Funded by [optional]:** {{ funded_by | default("[More Information Needed]", true)}}
+- **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
+- **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}}
+- **License:** {{ license | default("MIT", true)}}
+
+### Dataset Sources [optional]
+
+<!-- [Provide the basic links for the dataset.](https://actions.quarte-riposte.com/) -->
+
+- **Repository:** {{ repo | default("[More Information Needed]", true)}}
+- **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
+- **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+{{ direct_use | default("image classification", true)}}
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+
+{{ out_of_scope_use | default("[More Information Needed]", true)}}
+
+## 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_structure | default("The original split contains thirty screenshots retrieved from the source below.", true)}}
+{{ dataset_structure | default("15 images of the original split show frames where a point has not yet been awarded, while 15 show frames where a point has been awarded.", true)}}
+{{ dataset_structure | default("The augmented split shows 300 images that have been augmented via torchvision transforms.", true)}}
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+
+{{ curation_rationale_section | default("[More Information Needed]", true)}}
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+#### Data Collection and Processing
+
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+
+{{ data_collection_and_processing_section | default("[More Information Needed]", true)}}
+
+#### Who are the source data producers?
+
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+
+{{ source_data_producers_section | default("original split screenshots retrieved from https://actions.quarte-riposte.com/", true)}}
+
+### Annotations [optional]
+
+<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+
+#### Annotation process
+
+<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+
+{{ annotation_process_section | default("the original split data was labelled manually based on the scorebug monitor from the screenshots", true)}}
+
+#### Who are the annotators?
+
+<!-- This section describes the people or systems who created the annotations. -->
+
+{{ who_are_annotators_section | default("[More Information Needed]", true)}}
+
+#### Personal and Sensitive Information
+
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+
+{{ personal_and_sensitive_information | default("[More Information Needed]", true)}}
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+{{ bias_risks_limitations | default("[More Information Needed]", true)}}
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+{{ bias_recommendations | default("Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.", true)}}
+
+## Citation [optional]
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+{{ citation_bibtex | default("[More Information Needed]", true)}}
+
+**APA:**
+
+{{ citation_apa | default("[More Information Needed]", true)}}
+
+## Glossary [optional]
+
+<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+
+{{ glossary | default("[More Information Needed]", true)}}
+
+## More Information [optional]
+
+{{ more_information | default("[More Information Needed]", true)}}
+
+## Dataset Card Authors [optional]
+
+{{ dataset_card_authors | default("[More Information Needed]", true)}}
+
+## Dataset Card Contact
+
+{{ dataset_card_contact | default("[More Information Needed]", true)}}