Skip to content

Commit

Permalink
Merge pull request #3586 from rpgoldman/sample-docstring
Browse files Browse the repository at this point in the history
Clean up docstring for `sample`.
  • Loading branch information
fonnesbeck committed Aug 14, 2019
2 parents 3746666 + 7998ebb commit c1b9272
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions pymc3/sampling.py
Expand Up @@ -186,9 +186,6 @@ def sample(draws=500, step=None, init='auto', n_init=200000, start=None, trace=N
draws : int
The number of samples to draw. Defaults to 500. The number of tuned samples are discarded
by default. See ``discard_tuned_samples``.
step : function or iterable of functions
A step function or collection of functions. If there are variables without a step methods,
step methods for those variables will be assigned automatically.
init : str
Initialization method to use for auto-assigned NUTS samplers.
Expand All @@ -209,6 +206,11 @@ def sample(draws=500, step=None, init='auto', n_init=200000, start=None, trace=N
* advi_map: Initialize ADVI with MAP and use MAP as starting point.
* map : Use the MAP as starting point. This is discouraged.
* nuts : Run NUTS and estimate posterior mean and mass matrix from the trace.
step : function or iterable of functions
A step function or collection of functions. If there are variables without step methods,
step methods for those variables will be assigned automatically. By default the NUTS step
method will be used, if appropriate to the model; this is a good default for beginning
users.
n_init : int
Number of iterations of initializer. Only works for 'nuts' and 'ADVI'.
If 'ADVI', number of iterations, if 'nuts', number of draws.
Expand Down

0 comments on commit c1b9272

Please sign in to comment.