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 DCASE-bioacoustic #112

Merged
merged 16 commits into from
Apr 18, 2023
Merged

Adding loader for DCASE-bioacoustic #112

merged 16 commits into from
Apr 18, 2023

Conversation

nkundiushuti
Copy link
Collaborator

Dataloader for the dataset used in this task https://dcase.community/challenge2022/task-few-shot-bioacoustic-event-detection

Description

Please include the following information at the top level docstring for the dataset's module mydataset.py:

  • [x ] Describe annotations included in the dataset
  • [ x] Indicate the total duration of the dataset in hours, and (optionally) also list the number of individual files
  • [ x] Mention the origin of the dataset (e.g. creator, institution)
  • [ x] Describe the type of audio included in the dataset
  • [x ] Indicate any relevant papers related to the dataset
  • [x ] Include a description about how the data can be accessed and the license it uses (if applicable)

Dataset loaders checklist:

  • [x ] Create a script in scripts/, e.g. make_my_dataset_index.py, which generates an index file.
  • [ x] Run the script on the canonical version of the dataset and save the index in soundata/indexes/ e.g. my_dataset_index.json.
  • [ x] Create a module in soundata, e.g. soundata/my_dataset.py
  • [x ] Create tests for your loader in tests/, e.g. test_my_dataset.py
  • [ x] Add your module to docs/source/soundata.rst and docs/source/quick_reference.rst
  • [ x] Run tests/test_full_dataset.py on your dataset.

If your dataset is not fully downloadable there are two extra steps you should follow:

  • [ x] Contacting the soundata organizers by opening an issue or PR so we can discuss how to proceed with the closed dataset.
  • [x ] Show that the version used to create the checksum is the "canonical" one, either by getting the version from the dataset creator, or by verifying equivalence with several other copies of the dataset.
  • [x ] Make sure someone has run pytest -s tests/test_full_dataset.py --local --dataset my_dataset once on your dataset locally and confirmed it passes

Please-do-not-edit flag

To reduce friction, we will make commits on top of contributor's pull requests by default unless they use the please-do-not-edit flag. If you don't want this to happen don't forget to add the flag when you start your pull request.

@codecov
Copy link

codecov bot commented Feb 24, 2023

Codecov Report

Merging #112 (09a7825) into main (c8dc7a8) will increase coverage by 0.07%.
The diff coverage is 100.00%.

❗ Current head 09a7825 differs from pull request most recent head 3d3bcc2. Consider uploading reports for the commit 3d3bcc2 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #112      +/-   ##
==========================================
+ Coverage   98.52%   98.59%   +0.07%     
==========================================
  Files          24       25       +1     
  Lines        2096     2205     +109     
==========================================
+ Hits         2065     2174     +109     
  Misses         31       31              

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 @nkundiushuti, I am leaving here some comments/suggestions, mostly docs-related! The loader looks good :)

tests/datasets/test_dcase_bioacoustic.py Outdated Show resolved Hide resolved
soundata/datasets/dcase_bioacoustic.py Show resolved Hide resolved
soundata/datasets/dcase_bioacoustic.py Show resolved Hide resolved
soundata/datasets/dcase_bioacoustic.py Outdated Show resolved Hide resolved
soundata/datasets/dcase_bioacoustic.py Outdated Show resolved Hide resolved
soundata/datasets/dcase_bioacoustic.py Outdated Show resolved Hide resolved
soundata/datasets/dcase_bioacoustic.py Outdated Show resolved Hide resolved
soundata/datasets/dcase_bioacoustic.py Outdated Show resolved Hide resolved
soundata/datasets/dcase_bioacoustic.py Outdated Show resolved Hide resolved
@nkundiushuti
Copy link
Collaborator Author

should we merge it @genisplaja ?

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.

Yep! Sorry for the late response. I'm just leaving a tiny comment and looks ready to me :) I think the big docstring of the module could be a bit improved (for instance trying to highlight more the titles/sections so that is more readable), but all the information is there and it's just my personal thought, so feel free to merge otherwise:)

soundata/datasets/dcase_bioacoustic.py Outdated Show resolved Hide resolved
@nkundiushuti nkundiushuti merged commit 81f1990 into main Apr 18, 2023
@magdalenafuentes magdalenafuentes deleted the Marius/dcase branch February 6, 2024 21:31
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