Skip to content

Commit cd5b5de

Browse files
authored
Docstring updates
1 parent 60f0a0d commit cd5b5de

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

cmdstanpy/model.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -798,9 +798,11 @@ def sample(
798798
:param max_treedepth: Maximum depth of trees evaluated by NUTS sampler
799799
per iteration.
800800
801-
:param metric: Specify the type of the mass matrix. Options are
801+
:param metric: Specify the type of the inverse mass matrix. Options are
802802
'diag' or 'diag_e' for diagonal matrix, 'dense' or 'dense_e'
803-
for a dense matrix, or 'unit_e' an identity mass matrix.
803+
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.
804806
805807
:param inv_metric: Provide an initial value for the inverse
806808
mass matrix.

0 commit comments

Comments
 (0)