Fix binary_cross_entropy docstring argument order (weights before with_logits) - #3807
Merged
Merged
Conversation
zcbenz
force-pushed
the
fix/bce-docstring-arg-order
branch
from
July 6, 2026 23:41
c726406 to
7f09122
Compare
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.
The
binary_cross_entropyArgs block documents the parameters asinputs, targets, with_logits, weights, reduction, but the actual signature order isinputs, targets, weights, with_logits, reduction:A caller following the docstring order positionally, e.g.
binary_cross_entropy(logits, targets, False)intendingwith_logits=False, instead bindsweights=False. Theweights is not Nonebranch then doesweights.shapeon a bool and raisesAttributeError: 'bool' object has no attribute 'shape'.This reorders the two Args entries so
weightsprecedeswith_logits, matching the signature. The siblingcross_entropyin the same file already documentsweightsin its correct signature position. Docstring-only change.