Skip to content

Commit 2cb6f79

Browse files
Chris Fonnesbecktwiecki
Chris Fonnesbeck
authored andcommitted
Improved docstring for chains argument in sample
Now explains what happens when chains is left as None
1 parent a222c86 commit 2cb6f79

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

pymc3/sampling.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,10 @@ def sample(draws=500, step=None, init='auto', n_init=200000, start=None,
229229
chains : int
230230
The number of chains to sample. Running independent chains
231231
is important for some convergence statistics and can also
232-
reveal multiple modes in the posterior.
232+
reveal multiple modes in the posterior. If `None`, then set to
233+
either `njobs` or 2, whichever is larger.
233234
njobs : int
234-
The number of chains to run in parallel. If None, set to the
235+
The number of chains to run in parallel. If `None`, set to the
235236
number of CPUs in the system, but at most 4. Keep in mind that
236237
some chains might themselves be multithreaded via openmp or
237238
BLAS. In those cases it might be faster to set this to one.

0 commit comments

Comments
 (0)