Skip to content

Commit 52708e8

Browse files
committed
docs: Document low-rank mass matrix parameters
1 parent 551d48d commit 52708e8

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

python/nutpie/sample.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -574,7 +574,17 @@ def sample(
574574
Rate in ms at which the progress should be updated.
575575
low_rank_modified_mass_matrix: bool, default=False
576576
Allow adaptation to some posterior correlations using
577-
a low-rank updated mass matrix.
577+
a low-rank updated mass matrix. This is *experimental*
578+
and details about this will probably change in the next
579+
release.
580+
mass_matrix_eigval_cutoff: float > 1, defaul=100
581+
Ignore eigenvalues between cutoff and 1/cutoff in the
582+
low-rank modified mass matrix estimate. Higher values
583+
lead to worse correclation fitting, but increase
584+
the performance of leapfrog steps.
585+
mass_matrix_gamma: float > 0, default=1e-5
586+
Regularisation parameter for the eigenvalues. Only
587+
applicable with low_rank_modified_mass_matrix=True.
578588
**kwargs
579589
Pass additional arguments to nutpie._lib.PySamplerArgs
580590

0 commit comments

Comments
 (0)