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 freefield1010 #126

Merged
merged 20 commits into from
Dec 1, 2023
Merged

Adding loader for freefield1010 #126

merged 20 commits into from
Dec 1, 2023

Conversation

tanmayy24
Copy link
Collaborator

@tanmayy24 tanmayy24 commented Sep 28, 2023

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.

@tanmayy24 tanmayy24 changed the title Addition of freefield1010 dataset Addition of freefield dataset loader Sep 28, 2023
@tanmayy24 tanmayy24 changed the title Addition of freefield dataset loader [WIP] Adding loader for freefield1010 Sep 29, 2023
@codecov
Copy link

codecov bot commented Oct 6, 2023

Codecov Report

Merging #126 (d8a3dce) into main (73f26b9) will increase coverage by 0.02%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #126      +/-   ##
==========================================
+ Coverage   98.72%   98.75%   +0.02%     
==========================================
  Files          29       30       +1     
  Lines        2515     2570      +55     
==========================================
+ Hits         2483     2538      +55     
  Misses         32       32              

@tanmayy24 tanmayy24 changed the title [WIP] Adding loader for freefield1010 Adding loader for freefield1010 Oct 6, 2023
Copy link
Collaborator

@guillemcortes guillemcortes left a comment

Choose a reason for hiding this comment

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

Super minor changes. The rest looks good to me.

docs/source/soundata.rst Outdated Show resolved Hide resolved
docs/source/table.rst Outdated Show resolved Hide resolved
scripts/make_freefield1010_index.py Outdated Show resolved Hide resolved
soundata/datasets/freefield1010.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@guillemcortes guillemcortes left a comment

Choose a reason for hiding this comment

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

Good, ready to merge!

@tanmayy24 tanmayy24 merged commit efed9a0 into main Dec 1, 2023
11 checks passed
@magdalenafuentes magdalenafuentes deleted the tanmay/dcase_freefield branch February 6, 2024 21:36
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

4 participants