[x] Run tests/test_full_dataset.py on your dataset.
[x] Check that codecov coverage does not decrease.
If your dataset is not fully downloadable there are two extra steps you should follow:
[x] Contacting the mirdata organizers by opening an issue or PR so we can discuss how to proceed with the closed dataset.
[x] Show that the version used to create the checksum is the "canonical" one, either by getting the version from the dataset creator, or by verifying equivalence with several other copies of the dataset.
[x] Make sure someone has run pytest -s tests/test_full_dataset.py --local --dataset my_dataset once on your dataset locally and confirmed it passes.
Please-do-not-edit flag
To reduce friction, we will make commits on top of contributor's pull requests by default unless they use the please-do-not-edit flag. If you don't want this to happen don't forget to add the flag when you start your pull request.
Please include the following information at the top level docstring for the dataset's module mydataset.py:
Dataset loaders checklist:
scripts/
, e.g.make_my_dataset_index.py
, which generates an index file.mirdata/indexes/
e.g.my_dataset_index.json
.mirdata/my_dataset.py
tests/datasets/
, e.g.test_my_dataset.py
docs/source/mirdata.rst
anddocs/source/table.rst
black
,flake8
andmypy
(see Running your tests locally).tests/test_full_dataset.py
on your dataset.If your dataset is not fully downloadable there are two extra steps you should follow:
pytest -s tests/test_full_dataset.py --local --dataset my_dataset
once on your dataset locally and confirmed it passes.Please-do-not-edit flag
To reduce friction, we will make commits on top of contributor's pull requests by default unless they use the
please-do-not-edit
flag. If you don't want this to happen don't forget to add the flag when you start your pull request.