Skip to content

Conversation

@swarnaliiiiii
Copy link
Contributor

Fixes: #7904

This PR clarifies the documentation for ZeroSumNormal to 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:

ZSN(σ) = N(0, σ² (I_K - 1/K J_K))

No functional code changes — documentation only.

@welcome
Copy link

welcome bot commented Dec 5, 2025

Thank You Banner]
💖 Thanks for opening this pull request! 💖 The PyMC community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines and filled in our pull request template to the best of your ability.

@github-actions github-actions bot added the docs label Dec 5, 2025
Parameters
----------
sigma : tensor_like of float
Scale parameter (sigma > 0).
Copy link
Member

@ricardoV94 ricardoV94 Dec 6, 2025

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

@swarnaliiiiii
Copy link
Contributor 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.

@ricardoV94
Copy link
Member

There are clearly other changes, which you can confirm by clicking on
image

@ricardoV94 ricardoV94 requested a review from lucianopaz December 9, 2025 14:45
@swarnaliiiiii
Copy link
Contributor Author

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.

Copy link
Member

@lucianopaz lucianopaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm

@codecov
Copy link

codecov bot commented Dec 9, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.49%. Comparing base (ebd836e) to head (73f423d).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #7988   +/-   ##
=======================================
  Coverage   91.49%   91.49%           
=======================================
  Files         116      116           
  Lines       18972    18972           
=======================================
  Hits        17359    17359           
  Misses       1613     1613           
Files with missing lines Coverage Δ
pymc/distributions/multivariate.py 93.91% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ricardoV94 ricardoV94 merged commit cadb97a into pymc-devs:main Dec 10, 2025
26 checks passed
@welcome
Copy link

welcome bot commented Dec 10, 2025

Congratulations Banner]
Congrats on merging your first pull request! 🎉 We here at PyMC are proud of you! 💖 Thank you so much for your contribution 🎁

@ricardoV94 ricardoV94 changed the title DOC: Clarify ZeroSumNormal covariance documentation (#7904) Clarify ZeroSumNormal covariance documentation Dec 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Covariance matrix for ZeroSumNormal incorrect?

3 participants