Skip to content

DOC: Clarify Wishart distribution usage in docstring#8207

Open
Ahmadhassan011 wants to merge 14 commits intopymc-devs:mainfrom
Ahmadhassan011:docs/wishart-warning-clarification
Open

DOC: Clarify Wishart distribution usage in docstring#8207
Ahmadhassan011 wants to merge 14 commits intopymc-devs:mainfrom
Ahmadhassan011:docs/wishart-warning-clarification

Conversation

@Ahmadhassan011
Copy link
Copy Markdown

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 #8196

@read-the-docs-community
Copy link
Copy Markdown

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.

6 participants