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 Carnatic Varnam #579

Merged
merged 34 commits into from
Mar 27, 2023
Merged

Conversation

genisplaja
Copy link
Collaborator

@genisplaja genisplaja commented Feb 28, 2023

Adding loader for CompMusic Carnatic Varnam

This one has been pending for so long, so it's nice that we got it finally here!

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

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. This is done but we will have to re-run it when we have the new canonical (and fixed) version of the dataset.
  • Add new version in the index, remotes, docs.
  • 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
  • Update REMOTES
  • Run tests/test_full_dataset.py on your dataset.

Loader made possible thanks to @adithishankar19's help :)

@codecov
Copy link

codecov bot commented Mar 12, 2023

Codecov Report

Merging #579 (d39b732) into master (8c84e50) will increase coverage by 0.07%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #579      +/-   ##
==========================================
+ Coverage   96.88%   96.96%   +0.07%     
==========================================
  Files          57       58       +1     
  Lines        6816     6990     +174     
==========================================
+ Hits         6604     6778     +174     
  Misses        212      212              

@genisplaja genisplaja changed the title [WIP] Adding loader for CompMusic Carnatic Varnam Adding loader for CompMusic Carnatic Varnam Mar 14, 2023
Copy link
Collaborator

@harshpalan harshpalan left a comment

Choose a reason for hiding this comment

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

Hi @genisplaja, this looks good. I'll approve it. Please go ahead and merge it.

@genisplaja genisplaja merged commit 496eb4a into master Mar 27, 2023
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.

2 participants