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 MDB-stem-synth dataset #639

Merged
merged 13 commits into from
Nov 5, 2024
Merged

Adding loader for MDB-stem-synth dataset #639

merged 13 commits into from
Nov 5, 2024

Conversation

dsuedholt
Copy link
Contributor

Description

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.

Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.06%. Comparing base (9f797d2) to head (6f8ac77).
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #639      +/-   ##
==========================================
+ Coverage   97.05%   97.06%   +0.01%     
==========================================
  Files          66       67       +1     
  Lines        7498     7537      +39     
==========================================
+ Hits         7277     7316      +39     
  Misses        221      221              

Copy link
Collaborator

@genisplaja genisplaja left a comment

Choose a reason for hiding this comment

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

Hey @dsuedholt, great PR, very neat. Thanks for that! I am leaving few minor comments to make the docs render properly and to issue a small linting bug but LGTM.

docs/source/mirdata.rst Outdated Show resolved Hide resolved
mirdata/datasets/mdb_stem_synth.py Outdated Show resolved Hide resolved
@dsuedholt dsuedholt requested a review from genisplaja October 24, 2024 14:10
Copy link
Collaborator

@genisplaja genisplaja left a comment

Choose a reason for hiding this comment

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

LGTM :)

Copy link
Collaborator

@genisplaja genisplaja left a comment

Choose a reason for hiding this comment

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

hello again @dsuedholt :) Thanks for your time. Once this minor thing is done, I think we can merge :) If you have the time, could you please do it soon so that the loader can be included in the release we have scheduled for this week? Thanks!!

mirdata/datasets/mdb_stem_synth.py Outdated Show resolved Hide resolved
@dsuedholt
Copy link
Contributor Author

Thanks for the friendly and helpful review @genisplaja! Let me know if there's anything else you need for the release.

Copy link
Collaborator

@genisplaja genisplaja left a comment

Choose a reason for hiding this comment

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

I think now this is ready to merge :) Thanks @dsuedholt for the contributing and the timely responses!

@genisplaja genisplaja merged commit 19600df into mir-dataset-loaders:master Nov 5, 2024
10 checks passed
@dsuedholt dsuedholt deleted the mdb-stem-synth branch November 7, 2024 12:38
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.

4 participants