-
Notifications
You must be signed in to change notification settings - Fork 19
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
Conversation
Codecov Report
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 |
There was a problem hiding this 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 |
There was a problem hiding this comment.
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).
I agree that in this case, the docstring seems too large. The link could be a nice solution if it was a static link |
Description
Please include the following information at the top level docstring for the dataset's module mydataset.py:
Dataset loaders checklist:
scripts/
, e.g.make_my_dataset_index.py
, which generates an index file.soundata/indexes/
e.g.my_dataset_index.json
.soundata/my_dataset.py
.tests/
, e.g.test_my_dataset.py
.docs/source/soundata.rst
anddocs/source/quick_reference.rst
.black
,flake8
andmypy
(see Running your tests locally).tests/test_full_dataset.py
on your dataset.