Skip to content

Commit 83d0af5

Browse files
rpgoldmanColCarroll
authored andcommitted
Clarify docstring for sample_prior_predictive(). (#3114)
1 parent 1510a70 commit 83d0af5

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

pymc3/sampling.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1294,15 +1294,17 @@ def sample_prior_predictive(samples=500, model=None, vars=None, random_seed=None
12941294
Number of samples from the prior predictive to generate. Defaults to 500.
12951295
model : Model (optional if in `with` context)
12961296
vars : iterable
1297-
Variables for which to compute the posterior predictive samples.
1297+
A list of names of variables for which to compute the posterior predictive
1298+
samples.
12981299
Defaults to `model.named_vars`.
12991300
random_seed : int
13001301
Seed for the random number generator.
13011302
13021303
Returns
13031304
-------
13041305
dict
1305-
Dictionary with the variables as keys. The values are arrays of prior samples.
1306+
Dictionary with variable names as keys. The values are numpy arrays of prior
1307+
samples.
13061308
"""
13071309
model = modelcontext(model)
13081310

0 commit comments

Comments
 (0)