docs: document NUTS regularize_mass_matrix#2214
Merged
juanitorduz merged 2 commits intoJul 7, 2026
Merged
Conversation
juanitorduz
added
documentation
enhancement
juanitorduz
requested changes
Jul 7, 2026
juanitorduz
left a comment
juanitorduz
left a comment
Collaborator
There was a problem hiding this comment.
LGTM, but we need to move this to the bottom ;)
Comment on lines
+873
to
+875
| :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``. |
Collaborator
There was a problem hiding this comment.
Can you please put this at the end, matching the order of the arguments in the init function, please?
Contributor
Author
There was a problem hiding this comment.
Moved it to the bottom to match the constructor order.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds the missing
regularize_mass_matrixparameter description to theNUTSdocstring. The wording matches the existing HMC/internal initializer docs and the argument already exposed by theNUTSconstructor.Closes #2198.
Tests
NUTSdocstring now includesregularize_mass_matrixgit diff --checkuvx ruff check numpyro/infer/hmc.pyuvx ruff format --check numpyro/infer/hmc.py