Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding loader for Ballroom dataset #613

Merged

Conversation

tanmayy24
Copy link
Collaborator

@tanmayy24 tanmayy24 commented Jan 16, 2024

Please include the following information at the top level docstring for the dataset's module mydataset.py:

  • Describe annotations included in the dataset
  • Indicate the size of the datasets (e.g. number files and duration, hours)
  • Mention the origin of the dataset (e.g. creator, institution)
  • Describe the type of music included in the dataset
  • Indicate any relevant papers related to the dataset
  • Include a description about how the data can be accessed and the license it uses (if applicable)

Dataset loaders checklist:

  • Create a script in scripts/, e.g. make_my_dataset_index.py, which generates an index file.
  • Run the script on the canonical version of the dataset and save the index in mirdata/indexes/ e.g. my_dataset_index.json.
  • Create a module in mirdata, e.g. mirdata/my_dataset.py
  • Create tests for your loader in tests/datasets/, e.g. test_my_dataset.py
  • Add your module to docs/source/mirdata.rst and docs/source/table.rst
  • Run black, flake8 and mypy (see Running your tests locally).
  • Run tests/test_full_dataset.py on your dataset.
  • Check that codecov coverage does not decrease.

If your dataset is not fully downloadable there are two extra steps you should follow:

  • Contacting the mirdata organizers by opening an issue or PR so we can discuss how to proceed with the closed dataset.
  • 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.
  • 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.

Copy link

codecov bot commented Jan 16, 2024

Codecov Report

Merging #613 (b9f6359) into master (459833a) will decrease coverage by 0.02%.
The diff coverage is 94.54%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #613      +/-   ##
==========================================
- Coverage   97.09%   97.07%   -0.02%     
==========================================
  Files          62       63       +1     
  Lines        7286     7341      +55     
==========================================
+ Hits         7074     7126      +52     
- Misses        212      215       +3     

@tanmayy24 tanmayy24 changed the title Adding loader for Ballroom [WIP] Adding loader for Ballroom Jan 16, 2024
@tanmayy24 tanmayy24 changed the title [WIP] Adding loader for Ballroom Adding loader for Ballroom Jan 18, 2024
@tanmayy24 tanmayy24 changed the title Adding loader for Ballroom Adding loader for Ballroom dataset Jan 18, 2024
Copy link
Collaborator

@magdalenafuentes magdalenafuentes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tanmayy24 great job! Left minor comments, we're almost ready to go!

mirdata/datasets/ballroom.py Show resolved Hide resolved
mirdata/datasets/ballroom.py Outdated Show resolved Hide resolved
mirdata/datasets/ballroom.py Show resolved Hide resolved
mirdata/datasets/ballroom.py Outdated Show resolved Hide resolved
docs/source/table.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@magdalenafuentes magdalenafuentes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job! Merging this one

@magdalenafuentes magdalenafuentes merged commit 2c4ee52 into mir-dataset-loaders:master Feb 1, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants