Skip to content

docs: document NUTS regularize_mass_matrix #2214

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
juanitorduz merged 2 commits into from
Jul 7, 2026
+3 −0
Merged

docs: document NUTS regularize_mass_matrix #2214

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59b0a78
docs: document NUTS regularize_mass_matrix
ahfoysal Jul 7, 2026
1582a1f
docs: move regularize_mass_matrix docs to match signature order
ahfoysal Jul 7, 2026
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
3 changes: 3 additions & 0 deletions numpyro/infer/hmc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -870,6 +870,9 @@ class NUTS(HMC):
during warm-up phase using Dual Averaging scheme.
:param bool adapt_mass_matrix: A flag to decide if we want to adapt mass
matrix during warm-up phase using Welford scheme.
:param bool regularize_mass_matrix: whether or not to regularize the estimated mass
matrix for numerical stability during warmup phase. Defaults to True. This flag
does not take effect if ``adapt_mass_matrix == False``.

@juanitorduz juanitorduz Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Can you please put this at the end, matching the order of the arguments in the init function, please?

@ahfoysal ahfoysal Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Moved it to the bottom to match the constructor order.

:param dense_mass: This flag controls whether mass matrix is dense (i.e. full-rank) or
diagonal (defaults to ``dense_mass=False``). To specify a structured mass matrix,
users can provide a list of tuples of site names. Each tuple represents
Expand Down
Loading