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 Warblrb10k #132

Merged
merged 8 commits into from
Nov 30, 2023
Merged

Adding loader for Warblrb10k #132

merged 8 commits into from
Nov 30, 2023

Conversation

tanmayy24
Copy link
Collaborator

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 total duration of the dataset in hours, and (optionally) also list the number of individual files
  • Mention the origin of the dataset (e.g. creator, institution)
  • Describe the type of audio 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 soundata/indexes/ e.g. my_dataset_index.json.
  • Create a module in soundata, e.g. soundata/my_dataset.py.
  • Create tests for your loader in tests/, e.g. test_my_dataset.py.
  • Add your module to docs/source/soundata.rst and docs/source/quick_reference.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.

@codecov
Copy link

codecov bot commented Oct 13, 2023

Codecov Report

Merging #132 (ead0522) into main (2649ce1) will increase coverage by 0.03%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #132      +/-   ##
==========================================
+ Coverage   98.61%   98.64%   +0.03%     
==========================================
  Files          26       27       +1     
  Lines        2311     2363      +52     
==========================================
+ Hits         2279     2331      +52     
  Misses         32       32              

Copy link
Collaborator

@genisplaja genisplaja left a comment

Choose a reason for hiding this comment

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

Hey @tanmayy24, the loader and tests look really good to me :) Thanks for that! Just left minor requested changes mostly on documentation! Let me know if I misunderstood something... thanks!

docs/source/soundata.rst Outdated Show resolved Hide resolved
soundata/datasets/indexes/warblrb10k.json Outdated Show resolved Hide resolved
soundata/datasets/warblrb10k.py Outdated Show resolved Hide resolved
soundata/datasets/warblrb10k.py Outdated Show resolved Hide resolved
soundata/datasets/warblrb10k.py Outdated Show resolved Hide resolved
soundata/datasets/warblrb10k.py Outdated Show resolved Hide resolved
soundata/jams_utils.py Outdated Show resolved Hide resolved
tests/test_loaders.py Outdated Show resolved Hide resolved
soundata/datasets/warblrb10k.py Outdated Show resolved Hide resolved
soundata/datasets/warblrb10k.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@genisplaja genisplaja left a comment

Choose a reason for hiding this comment

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

Thanks @tanmayy24!! This looks good to me :) I'm approving the PR now

@tanmayy24 tanmayy24 merged commit 6a5de09 into main Nov 30, 2023
11 checks passed
@magdalenafuentes magdalenafuentes deleted the tanmay/warblr branch February 6, 2024 21:46
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.

None yet

3 participants