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 MIR-1K #649

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

dsuedholt
Copy link
Contributor

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 upload the index to Zenodo Audio Data Loaders community.
  • Create a sample version of the index with the necessary information for testing.
  • 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 black, flake8 and mypy (see Running your tests locally).
  • Run tests/test_full_dataset.py on your dataset.
  • Check that codecov coverage does not decrease.

Other recordings

The MIR-1K dataset is based on 110 song recordings split into 1000 clips.

The dataset download also includes a folder UndividedWavfile which contains the "un-split" recordings. Additionally, while all other annotation files are on the clip level, the download also includes a LyricsWav folder containing recordings of the song lyrics being read aloud (as speech, not singing), but these correspond to the 110 "un-split" songs, not the 1000 clips. So I wasn't quite sure how to handle these within the mirdata structures, for now I simply ignored them.

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.09%. Comparing base (581f4c4) to head (71e0998).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #649      +/-   ##
==========================================
+ Coverage   97.07%   97.09%   +0.01%     
==========================================
  Files          68       69       +1     
  Lines        7583     7664      +81     
==========================================
+ Hits         7361     7441      +80     
- Misses        222      223       +1     

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.

1 participant