Skip to content

Commit

Permalink
Clarify docstring for sample_prior_predictive(). (#3114)
Browse files Browse the repository at this point in the history
  • Loading branch information
rpgoldman authored and ColCarroll committed Jul 24, 2018
1 parent 1510a70 commit 83d0af5
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions pymc3/sampling.py
Original file line number Diff line number Diff line change
Expand Up @@ -1294,15 +1294,17 @@ def sample_prior_predictive(samples=500, model=None, vars=None, random_seed=None
Number of samples from the prior predictive to generate. Defaults to 500.
model : Model (optional if in `with` context)
vars : iterable
Variables for which to compute the posterior predictive samples.
A list of names of variables for which to compute the posterior predictive
samples.
Defaults to `model.named_vars`.
random_seed : int
Seed for the random number generator.
Returns
-------
dict
Dictionary with the variables as keys. The values are arrays of prior samples.
Dictionary with variable names as keys. The values are numpy arrays of prior
samples.
"""
model = modelcontext(model)

Expand Down

0 comments on commit 83d0af5

Please sign in to comment.