We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 60f0a0d commit cd5b5deCopy full SHA for cd5b5de
cmdstanpy/model.py
@@ -798,9 +798,11 @@ def sample(
798
:param max_treedepth: Maximum depth of trees evaluated by NUTS sampler
799
per iteration.
800
801
- :param metric: Specify the type of the mass matrix. Options are
+ :param metric: Specify the type of the inverse mass matrix. Options are
802
'diag' or 'diag_e' for diagonal matrix, 'dense' or 'dense_e'
803
- for a dense matrix, or 'unit_e' an identity mass matrix.
+ for a dense matrix, or 'unit_e' an identity mass matrix. To provide
804
+ an initial value for the inverse mass matrix, use the ``inv_metric``
805
+ argument.
806
807
:param inv_metric: Provide an initial value for the inverse
808
mass matrix.
0 commit comments