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 Music Rhythm #560

Merged
merged 27 commits into from
Nov 22, 2022
Merged

Conversation

genisplaja
Copy link
Collaborator

@genisplaja genisplaja commented Oct 26, 2022

Adding loader for (Compmusic) Carnatic Music Rhythm

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.

@genisplaja genisplaja added the new loader request to add a specific dataset loader label Oct 26, 2022
@codecov
Copy link

codecov bot commented Nov 7, 2022

Codecov Report

Merging #560 (7eb1a18) into master (c8865cb) will increase coverage by 0.01%.
The diff coverage is 97.50%.

@@            Coverage Diff             @@
##           master     #560      +/-   ##
==========================================
+ Coverage   96.79%   96.81%   +0.01%     
==========================================
  Files          53       54       +1     
  Lines        6499     6619     +120     
==========================================
+ Hits         6291     6408     +117     
- Misses        208      211       +3     

@genisplaja
Copy link
Collaborator Author

genisplaja commented Nov 7, 2022

Hi @nkundiushuti, @magdalenafuentes and @harshpalan. As discussed the last week, I got this dataloader done using the optional dependencies as usual. Do you have any idea why the docs are not rendering properly? I went through the raw but I cannot find any specific error there. Regarding the rest of TODOS, looks like this is ready to be reviewed :)

@nkundiushuti nkundiushuti self-requested a review November 18, 2022 18:48
docs/source/table.rst Show resolved Hide resolved
try:
from openpyxl import load_workbook as get_xlxs
except ImportError:
logging.error(
Copy link
Collaborator

Choose a reason for hiding this comment

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

it looks like this is not covered by test? is this to be compliant with what Harsh is doing on partial dependency checks? maybe we could have a global test for that

mirdata/datasets/compmusic_carnatic_rhythm.py Show resolved Hide resolved
mirdata/datasets/compmusic_carnatic_rhythm.py Show resolved Hide resolved
mirdata/datasets/compmusic_carnatic_rhythm.py Show resolved Hide resolved
@genisplaja genisplaja merged commit 4b67c85 into master Nov 22, 2022
@genisplaja genisplaja deleted the genis/cmr branch November 22, 2022 20:59
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.

2 participants