Skip to content

Commit c34dc84

Browse files
committed
add a parameter description for require_converged in the variational interface
1 parent 0869a28 commit c34dc84

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

cmdstanpy/model.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -974,6 +974,9 @@ def variational(
974974
:param output_samples: Number of approximate posterior output draws
975975
to save.
976976
977+
:param require_converged: Whether or not to raise an error if stan
978+
reports that "The algorithm may not have converged".
979+
977980
:return: CmdStanVB object
978981
"""
979982
variational_args = VariationalArgs(

0 commit comments

Comments
 (0)