Fix Bilinear weight shape in docstring#3770
Closed
Pablosinyores wants to merge 1 commit into
Closed
Conversation
nn.Bilinear stores its weight as [output_dims, input2_dims, input1_dims] (the __call__ and extra_repr both unpack it that way), but the docstring documented [output_dims, input1_dims, input2_dims], swapping the two input dimensions. Correct the docstring and pin the weight shape in test_bilinear so the documented order stays in sync with the implementation.
Collaborator
|
Thanks for the PR, this had been fixed by #3758, please let us know if it is missing anything. |
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
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.
Summary
nn.Bilinearstores its weight as[output_dims, input2_dims, input1_dims]— both__call__andextra_reprunpack it asout, in2, in1 = self.weight.shape, and the forward computesW[o, in2, in1]. The docstring, however, documented[output_dims, input1_dims, input2_dims], swapping the two input dimensions.This corrects the docstring to the actual stored order and pins the weight shape in
test_bilinearso the documented order stays in sync with the implementation.Behavior is unchanged (docs + test only).
Checklist
pre-commit/blackon my changes