Skip to content

Commit

Permalink
docs: Mention PyStan-specific num_chains kwarg
Browse files Browse the repository at this point in the history
Mention the PyStan-specific `num_chains` keyword argument. This
is the only PyStan-specific argument. All other keyword arguments
are passed to the stan::services function.

Closes #112
  • Loading branch information
riddell-stan committed Jan 18, 2021
1 parent 2426d63 commit 28cc94d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions stan/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ def sample(self, **kwargs) -> stan.fit.Fit:
See the CmdStan documentation for parameter descriptions and default
values.
`num_chains` is the lone PyStan-specific keyword argument. It indicates
the number of independent processes to use when drawing samples.
The default value is 1.
Returns:
Fit: instance of Fit allowing access to draws.
Expand Down

0 comments on commit 28cc94d

Please sign in to comment.