From 52708e84713ffed6a36294028899b9c605e9caa1 Mon Sep 17 00:00:00 2001 From: Adrian Seyboldt Date: Fri, 5 Jul 2024 19:32:59 +0200 Subject: [PATCH] docs: Document low-rank mass matrix parameters --- python/nutpie/sample.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/python/nutpie/sample.py b/python/nutpie/sample.py index 3238fb2..6c5bfc6 100644 --- a/python/nutpie/sample.py +++ b/python/nutpie/sample.py @@ -574,7 +574,17 @@ def sample( Rate in ms at which the progress should be updated. low_rank_modified_mass_matrix: bool, default=False Allow adaptation to some posterior correlations using - a low-rank updated mass matrix. + a low-rank updated mass matrix. This is *experimental* + and details about this will probably change in the next + release. + mass_matrix_eigval_cutoff: float > 1, defaul=100 + Ignore eigenvalues between cutoff and 1/cutoff in the + low-rank modified mass matrix estimate. Higher values + lead to worse correclation fitting, but increase + the performance of leapfrog steps. + mass_matrix_gamma: float > 0, default=1e-5 + Regularisation parameter for the eigenvalues. Only + applicable with low_rank_modified_mass_matrix=True. **kwargs Pass additional arguments to nutpie._lib.PySamplerArgs