-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Clarify ZeroSumNormal covariance documentation #7988
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
|
| Parameters | ||
| ---------- | ||
| sigma : tensor_like of float | ||
| Scale parameter (sigma > 0). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should not remove any of this previous stuff
|
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. |
|
The math block has been updated to use K (size of the constrained axis) instead of n, with all previous documentation left intact. Only a part of the formula was replaced. |
lucianopaz
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7988 +/- ##
=======================================
Coverage 91.49% 91.49%
=======================================
Files 116 116
Lines 18972 18972
=======================================
Hits 17359 17359
Misses 1613 1613
🚀 New features to boost your workflow:
|



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.