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 Candombe #606

Merged
merged 20 commits into from
Nov 3, 2023
Merged

Adding loader for Candombe #606

merged 20 commits into from
Nov 3, 2023

Conversation

tanmayy24
Copy link
Collaborator

@tanmayy24 tanmayy24 commented Nov 3, 2023

Candombe dataset

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 tests/test_full_dataset.py on your dataset.

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.

As discussed with @magdalenafuentes, here's the PR regarding the dataset for "Uruguayan candombe drumming - beat and downbeat tracking data set" by Martin Rocamora and Luis Jure is now hosted in Zenodo: https://zenodo.org/record/6533068/

This PR includes a dataloader and everything needed as described in the Contributing page.

Note: this PR takes #553 and fixes the formatting issue so we can merge for release. Authored by @jimearruti

@magdalenafuentes magdalenafuentes changed the title Black Fixes for Candombe Dataset Adding loader for Candombe Nov 3, 2023
Copy link

codecov bot commented Nov 3, 2023

Codecov Report

Merging #606 (56ae563) into master (496eb4a) will increase coverage by 0.11%.
Report is 10 commits behind head on master.
The diff coverage is 98.99%.

@@            Coverage Diff             @@
##           master     #606      +/-   ##
==========================================
+ Coverage   96.96%   97.08%   +0.11%     
==========================================
  Files          58       62       +4     
  Lines        6990     7277     +287     
==========================================
+ Hits         6778     7065     +287     
  Misses        212      212              

@magdalenafuentes magdalenafuentes merged commit 7fceb2f into mir-dataset-loaders:master Nov 3, 2023
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.

6 participants