Skip to content

Commit b407c01

Browse files
tvwengeraloctavodia
authored andcommitted
update docs
1 parent 8ffb951 commit b407c01

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

pymc/smc/kernels.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,9 @@ class SMC_KERNEL(ABC):
5353
initialize_population
5454
Choose initial population of SMC particles. Should return a dictionary
5555
with {var.name : numpy array of size (draws, var.size)}. Defaults
56-
to sampling from the prior distribution. This method is only called
57-
if `start` is not specified.
56+
to sampling from the prior distribution, except for parameters which have custom
57+
`initval`, in which case that value is used for all SMC particles.
58+
This method is only called if `start` is not specified.
5859
5960
_initialize_kernel : default
6061
Creates initial population of particles in the variable
@@ -144,7 +145,8 @@ def __init__(
144145
independent chains. Defaults to 2000.
145146
start : dict, or array of dict, default None
146147
Starting point in parameter space. It should be a list of dict with length `chains`.
147-
When None (default) the starting point is sampled from the prior distribution.
148+
When None (default) the starting point is sampled from the prior distribution, except
149+
for parameters with a custom `initval`, in which case that value is used.
148150
model : Model (optional if in ``with`` context).
149151
random_seed : int, array_like of int, RandomState or Generator, optional
150152
Value used to initialize the random number generator.

0 commit comments

Comments
 (0)