DOC: Clarify ZeroSumNormal covariance documentation (#7904) #7988
+32
−32
Conversation
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
|
|
ricardoV94
reviewed
Dec 6, 2025
| Parameters | ||
| ---------- | ||
| sigma : tensor_like of float | ||
| Scale parameter (sigma > 0). |
Member
There was a problem hiding this comment.
Should not remove any of this previous stuff
Author
|
Updated the docstring to use K (size of the constrained axis) instead of n in the covariance formula. This corrects the notation as discussed in issue #7904. No other text was removed or changed. |
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.
Fixes: #7904
This PR clarifies the documentation for
ZeroSumNormalto use K (size of the constrained axis)instead of n (number of zero-sum axes), as discussed in the issue.
It updates the docstring math expression:
No functional code changes — documentation only.