Skip to content

Fix error in docstring example for MatrixNormal #7599

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Dec 11, 2024
Merged

Fix error in docstring example for MatrixNormal #7599

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5155844
updated docstring for pm.MatrixNormal to ensure compatibility with cu…
Dec 1, 2024
3f57642
Update pymc/distributions/multivariate.py
roesta07 Dec 3, 2024
c219a4a
updated docstring for pm.MatrixNormal after review
Dec 7, 2024
7e47f7a
updated docstring for pm.MatrixNormal-after review
Dec 10, 2024
c2edfb1
after adding codeblocks,imports
Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions pymc/distributions/multivariate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1792,7 +1792,7 @@ class MatrixNormal(Continuous):
--------
Define a matrixvariate normal variable for given row and column covariance
matrices::

with pm.Model() as model:
Copy link
Member

@ricardoV94 ricardoV94 Dec 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Should add a .. code:: python with white line above and below to render nicely

Copy link
Member

Choose a reason for hiding this comment

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

Also include imports so example is fully specified

Copy link
Contributor Author

@roesta07 roesta07 Dec 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

  • added imports on top.
  • added codeblocks .. code:: python with appropriate whitespaces
    Check these recent changes

colcov = np.array([[1.0, 0.5], [0.5, 2]])
rowcov = np.array([[1, 0, 0], [0, 4, 0], [0, 0, 16]])
m = rowcov.shape[0]
Expand Down Expand Up @@ -1827,16 +1827,13 @@ class MatrixNormal(Continuous):
with pm.Model() as model:
# Setup right cholesky matrix
sd_dist = pm.HalfCauchy.dist(beta=2.5, shape=3)
colchol_packed = pm.LKJCholeskyCov('colcholpacked', n=3, eta=2,
sd_dist=sd_dist)
colchol = pm.expand_packed_triangular(3, colchol_packed)

colchol,_,_ = pm.LKJCholeskyCov('colchol', n=3, eta=2,sd_dist=sd_dist)
# Setup left covariance matrix
scale = pm.LogNormal('scale', mu=np.log(true_scale), sigma=0.5)
rowcov = pt.diag([scale**(2*i) for i in range(m)])

vals = pm.MatrixNormal('vals', mu=mu, colchol=colchol, rowcov=rowcov,
Copy link
Member

@ricardoV94 ricardoV94 Dec 3, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The suggestion can't be applied directyl, but this seems more clean

Suggested change
vals = pm.MatrixNormal('vals', mu=mu, colchol=colchol, rowcov=rowcov,
vals = pm.MatrixNormal('vals', mu=mu, colchol=colchol, rowcov=rowcov, observed=data)

Copy link
Member

Choose a reason for hiding this comment

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

Missid this. I would put in same line, looks odd split

observed=data)
observed=data)
"""

rv_op = matrixnormal
Expand Down
Loading