Skip to content

DOC: Clarify Wishart distribution usage in docstring#1

Merged
Ahmadhassan011 merged 1 commit into
v6from
docs/wishart-warning-clarification
Mar 19, 2026
Merged

DOC: Clarify Wishart distribution usage in docstring#1
Ahmadhassan011 merged 1 commit into
v6from
docs/wishart-warning-clarification

Conversation

@Ahmadhassan011

Copy link
Copy Markdown
Owner

Description

This PR improves the documentation for the Wishart distribution to clarify its practical limitations and use cases.

Changes

  • Updated the Notes section to distinguish between prior use (not recommended) and likelihood use (allowed)
  • Added explanation of why Wishart is problematic for MCMC sampling (SPD manifold)
  • Referenced LKJCholeskyCov/LKJCorr as alternatives
  • Made the documentation more precise than the previous "unusable" statement

Issue

Closes pymc-devs#8196

Checklist

  • Pre-commit checks passed
  • Documentation updated
  • No new tests needed (documentation only)

- Distinguish between prior use (not recommended) and likelihood use (allowed)
- Explain why Wishart is problematic for MCMC sampling
- Reference LKJCholeskyCov/LKJCorr as alternatives
- Closes pymc-devs#8196
@Ahmadhassan011 Ahmadhassan011 merged commit c0f5f21 into v6 Mar 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Clarify the pm.Wishart warning (“unusable in a PyMC model”)

1 participant