Skip to content

Commit 00a0d99

Browse files
authored
Create add_dataset.md
1 parent cbfc523 commit 00a0d99

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
- **Name:** *name of the dataset*
2+
- **Description:** *short description of the dataset (or link to social media or blog post)*
3+
- **Paper:** *link to the dataset paper if available*
4+
- **Data:** *link to the Github repository or current dataset location*
5+
- **Motivation:** *what are some good reasons to have this dataset*
6+
7+
### Checkbox
8+
9+
- [ ] Create the dataset script `/datasets/my_dataset/my_dataset.py` using the template
10+
- [ ] Fill the `_DESCRIPTION` and `_CITATION` variables
11+
- [ ] Implement `_infos()`, `_split_generators()` and `_generate_examples()`
12+
- [ ] Make sure that the `BUILDER_CONFIGS` class attribute is filled with the different configurations of the dataset and that the `BUILDER_CONFIG_CLASS` is specified if there is a custom config class.
13+
- [ ] Generate the metadata file `dataset_infos.json` for all configurations
14+
- [ ] Generate the dummy data `dummy_data.zip` files to have the dataset script tested and that they don't weigh too much (<50KB)
15+
- [ ] Add the dataset card `README.md` using the template : fill the tags and the various paragraphs
16+
- [ ] Both tests for the real data and the dummy data pass.

0 commit comments

Comments
 (0)