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 SCMS #597

Merged
merged 18 commits into from
Nov 3, 2023
Merged

Adding loader for SCMS #597

merged 18 commits into from
Nov 3, 2023

Conversation

genisplaja
Copy link
Collaborator

Adding loader for SCMS (Saraga Carnatic Melody Synth)

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.
  • 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.

@codecov
Copy link

codecov bot commented Oct 19, 2023

Codecov Report

Merging #597 (4450762) into master (496eb4a) will increase coverage by 0.10%.
Report is 9 commits behind head on master.
The diff coverage is 98.84%.

@@            Coverage Diff             @@
##           master     #597      +/-   ##
==========================================
+ Coverage   96.96%   97.07%   +0.10%     
==========================================
  Files          58       61       +3     
  Lines        6990     7238     +248     
==========================================
+ Hits         6778     7026     +248     
  Misses        212      212              

@guillemcortes guillemcortes added the new loader request to add a specific dataset loader label Oct 31, 2023
Copy link
Collaborator

@magdalenafuentes magdalenafuentes left a comment

Choose a reason for hiding this comment

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

Hey @genisplaja, looks great, left just minor comments. Let me know your thoughts and we can merge soon!

docs/source/quick_reference.rst Outdated Show resolved Hide resolved
mirdata/datasets/scms.py Outdated Show resolved Hide resolved
mirdata/datasets/scms.py Outdated Show resolved Hide resolved
return load_audio(*args, **kwargs)

def load_pitch(self, *args, **kwargs):
return load_pitch(*args, **kwargs)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here, is this the issue we discussed today that appears in most loaders?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

missed testing load_audio actually (done it now), but load_pitch and load_activations are actually tested, so I wonder if yeah, is one of these testing problems we discussed...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ok sorry @magdalenafuentes, these functions should not be there, were deprecated a few versions ago. The newest loaders do not have them actually, started from the wrong template hehe. Fixed!

mirdata/datasets/scms.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@magdalenafuentes magdalenafuentes left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @genisplaja

@magdalenafuentes magdalenafuentes merged commit a944318 into master Nov 3, 2023
10 checks passed
@guillemcortes guillemcortes deleted the genis/scms 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