fix convolutions docstrings#2883
Merged
Merged
Conversation
Adel-Moumen
approved these changes
Apr 10, 2025
Collaborator
Adel-Moumen
left a comment
Adel-Moumen
left a comment
There was a problem hiding this comment.
LGTM! Thanks for the improvements :)
Contributor
Author
|
@Adel-Moumen seems to be an issue with import order, gonna fix |
gfdb
force-pushed
the
fix-convolution-docstrings
branch
from
9aedf01 to
a71b8ad
Compare
Contributor
Author
|
@Adel-Moumen readthedocs test seems broken |
gfdb
force-pushed
the
fix-convolution-docstrings
branch
from
a71b8ad to
6caaa3a
Compare
Contributor
Author
|
@Adel-Moumen fixed it, merged .readthedocs.yaml in, despite it being exactly the same as the file on develop, it is registering as a change... |
Collaborator
|
Thanks @gfdb :) |
pplantinga
pushed a commit
to pplantinga/speechbrain
that referenced
this pull request
Jun 2, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Although I'm sure there are many doc string problems across the code base, I just happened to come across these ones while browsing the code. Many defaults are missing and some that are present are incorrect (different from the real default) in some cases, which can be very misleading when trying to debug. For example, residuals saying it defaults to None, but in reality it is True. This PR fixes these incorrect default values, adds ones that are missing, and improves the type hints overall. This is done by either adding a missing type hint or fixing it, such as the use of Optional[__] despite the user not being able to pass None for that parameter.
Fixes #<issue_number>
Before submitting
PR review
Reviewer checklist