Fix Conv3d docstring argument order (padding before dilation)#3793
Open
Pablosinyores wants to merge 1 commit into
Open
Fix Conv3d docstring argument order (padding before dilation)#3793Pablosinyores wants to merge 1 commit into
Pablosinyores wants to merge 1 commit into
Conversation
The Conv3d docstring listed the constructor arguments as stride, dilation, padding, but the signature order is stride, padding, dilation (matching Conv1d and Conv2d). A caller following the docstring with positional arguments would swap padding and dilation. Reorder the docstring to match the signature and the Conv1d/Conv2d docstrings.
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
1 participant
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.
The
Conv3ddocstring lists the constructor arguments asstride,dilation,padding, but the actual signature order isstride,padding,dilation— matchingConv1dandConv2d.A caller who follows the docstring order with positional arguments (e.g.
nn.Conv3d(3, 16, 3, 1, 2)intendingdilation=2) would instead setpadding=2.Conv3dwas the lone outlier here;Conv1dandConv2dboth documentstride -> padding -> dilation.Reorders the
Conv3ddocstring sopaddingprecedesdilation, matching the signature and the sibling conv layers. Documentation-only, no behavior change.