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 TAU Urban Acoustic Scenes 2022 #129

Merged
merged 15 commits into from
Nov 30, 2023
Merged

Conversation

tanmayy24
Copy link
Collaborator

@tanmayy24 tanmayy24 commented Oct 5, 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.

@codecov
Copy link

codecov bot commented Oct 6, 2023

Codecov Report

Merging #129 (04ff520) into main (6a5de09) will increase coverage by 0.04%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #129      +/-   ##
==========================================
+ Coverage   98.64%   98.69%   +0.04%     
==========================================
  Files          27       28       +1     
  Lines        2363     2447      +84     
==========================================
+ Hits         2331     2415      +84     
  Misses         32       32              

@tanmayy24 tanmayy24 changed the title [WIP] Adding loader for TAU Urban Acoustic Scenes 2022 Adding loader for TAU Urban Acoustic Scenes 2022 Oct 6, 2023
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.

The loaders looks really good to me, testing coverage is high and I couldn't spot any issues. Just a question... do we actually need to have this massive docstring for the loader? Have not checked the others yet but, maybe it's too much to have about 500 lines of code for all the tables and so on... if there was a link or something for more info we could redirect the user there, and keep the basic and most important details of the dataset in the docstring. What do you think about that @magdalenafuentes, @tanmayy24 and @guillemcortes? If it's OK to have it, then everything is rendering really nicely and the loader looks ready to me :)

"""The clip's split.

Returns:
* str - subset the clip belongs to (for experiments): development (fold1, fold2, fold3, fold4) or evaluation
Copy link
Collaborator

Choose a reason for hiding this comment

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

This line is not properly rendered.. maybe becuase of the :? Also I think we are not very consistent with the use of * before listing the attributes, input variables and so on. Sometimes we use it sometimes no. Maybe is not the goal of this PR but would be nice being consistent (unless there is a rule I am missing here).

@tanmayy24 tanmayy24 merged commit 5cb1204 into main Nov 30, 2023
11 checks passed
@guillemcortes
Copy link
Collaborator

The loaders looks really good to me, testing coverage is high and I couldn't spot any issues. Just a question... do we actually need to have this massive docstring for the loader? Have not checked the others yet but, maybe it's too much to have about 500 lines of code for all the tables and so on... if there was a link or something for more info we could redirect the user there, and keep the basic and most important details of the dataset in the docstring. What do you think about that @magdalenafuentes, @tanmayy24 and @guillemcortes? If it's OK to have it, then everything is rendering really nicely and the loader looks ready to me :)

I agree that in this case, the docstring seems too large. The link could be a nice solution if it was a static link

@magdalenafuentes magdalenafuentes deleted the tanmay/tau2022 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

5 participants