Upload README.md

README.md

@@ -6,52 +6,159 @@ tags:
 - gan
 - image
 - images
-task: unconditional-image-generation
+task: 
+- unconditional-image-generation
+datasets:
+- huggingnft/boredapeyachtclub
 license: mit
 ---
 
-# Hugging NFT: boredapeyachtclub
+# Dataset Card
 
 ## Disclaimer
 
-All rights belong to their owners. Models and datasets can be removed from the site at the request of the copyright
-holder.
-
-## Model description
-
-LightWeight GAN model for unconditional generation.
+All rights belong to their owners.
+Models and datasets can be removed from the site at the request of the copyright holder.
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [How to use](#how-to-use)
+- [Dataset Structure](#dataset-structure)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+- [About](#about)
+
+## Dataset Description
+
+- **Homepage:** [https://github.com/AlekseyKorshuk/huggingnft](https://github.com/AlekseyKorshuk/huggingnft)
+- **Repository:** [https://github.com/AlekseyKorshuk/huggingnft](https://github.com/AlekseyKorshuk/huggingnft)
+- **Paper:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Point of Contact:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+
+### Dataset Summary
+
+NFT images dataset for unconditional generation.
 
 NFT collection available [here](https://opensea.io/collection/boredapeyachtclub).
 
-Dataset is available [here](https://huggingface.co/datasets/huggingnft/boredapeyachtclub).
+Model is available [here](https://huggingface.co/huggingnft/boredapeyachtclub).
 
 Check Space: [link](https://huggingface.co/spaces/AlekseyKorshuk/huggingnft).
 
-Project repository: [link](https://github.com/AlekseyKorshuk/huggingnft).
+### Supported Tasks and Leaderboards
 
-[![GitHub stars](https://img.shields.io/github/stars/AlekseyKorshuk/huggingnft?style=social)](https://github.com/AlekseyKorshuk/huggingnft)
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+
+## How to use
+
+How to load this dataset directly with the datasets library:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("huggingnft/boredapeyachtclub")
+```
+
+## Dataset Structure
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+
+### Data Fields
+
+The data fields are the same among all splits.
+
+- `image`: an `image` feature.
+- `id`: an `int` feature.
+- `token_metadata`: a `str` feature.
+- `image_original_url`: a `str` feature.
+
+### Data Splits
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
-## Intended uses & limitations
+#### Who are the source language producers?
 
-#### How to use
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
-Check project repository: [link](https://github.com/AlekseyKorshuk/huggingnft).
+### Annotations
 
-#### Limitations and bias
+#### Annotation process
 
-Check project repository: [link](https://github.com/AlekseyKorshuk/huggingnft).
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
-## Training data
+#### Who are the annotators?
 
-Dataset is available [here](https://huggingface.co/datasets/huggingnft/boredapeyachtclub).
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
-## Training procedure
+### Personal and Sensitive Information
 
-Training script is available [here](https://github.com/AlekseyKorshuk/huggingnft).
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
-## Generated Images
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Discussion of Biases
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Other Known Limitations
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Licensing Information
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Citation Information
+
+```
+@InProceedings{huggingnft,
+    author={Aleksey Korshuk}
+    year=2022
+}
+```
 
-Check results with Space: [link](https://huggingface.co/spaces/AlekseyKorshuk/huggingnft).
 
 ## About
 
@@ -66,12 +173,3 @@ Check results with Space: [link](https://huggingface.co/spaces/AlekseyKorshuk/hu
 For more details, visit the project repository.
 
 [![GitHub stars](https://img.shields.io/github/stars/AlekseyKorshuk/huggingnft?style=social)](https://github.com/AlekseyKorshuk/huggingnft)
-
-### BibTeX entry and citation info
-
-```bibtex
-@InProceedings{huggingnft,
-    author={Aleksey Korshuk}
-    year=2022
-}
-```