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 CompMusic Raga Dataset #559

Merged
merged 27 commits into from
Nov 22, 2022
Merged

Adding loader for CompMusic Raga Dataset #559

merged 27 commits into from
Nov 22, 2022

Conversation

genisplaja
Copy link
Collaborator

@genisplaja genisplaja commented Oct 22, 2022

Adding loader for CompMusic Raga 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 (ongoing, it takes a while)

At the moment there is no Zenodo entry for this dataset. We will create it soon, separating the audio (which must be restricted) and the annotations/features (which are open).

@codecov
Copy link

codecov bot commented Oct 24, 2022

Codecov Report

Merging #559 (4fe8456) into master (a5db106) will increase coverage by 0.08%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #559      +/-   ##
==========================================
+ Coverage   96.67%   96.75%   +0.08%     
==========================================
  Files          50       51       +1     
  Lines        6160     6313     +153     
==========================================
+ Hits         5955     6108     +153     
  Misses        205      205              

@genisplaja genisplaja changed the title [WIP] Adding loader for CompMusic Raga Dataset Adding loader for CompMusic Raga Dataset Oct 24, 2022
@genisplaja genisplaja added the new loader request to add a specific dataset loader label Oct 26, 2022
@nkundiushuti nkundiushuti self-requested a review October 27, 2022 14:01
docs/source/table.rst Outdated Show resolved Hide resolved
mirdata/datasets/compmusic_raga_dataset.py Outdated Show resolved Hide resolved
scripts/make_compmusic_raga_index.py Show resolved Hide resolved
@magdalenafuentes
Copy link
Collaborator

@genisplaja small request: can you change the name of the module from compumusic_raga_dataset to simply compmusic_raga? it will make our lives easier in the tables and for the user if the name is shorter

@genisplaja
Copy link
Collaborator Author

genisplaja commented Nov 9, 2022

@magdalenafuentes done:) The part _dataset definitely not needed here!

@genisplaja genisplaja merged commit be77d56 into master Nov 22, 2022
@guillemcortes guillemcortes deleted the indian_raga branch November 1, 2024 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new loader request to add a specific dataset loader
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants