Clarify docstring for sample_prior_predictive(). #3114
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you! That is also a good point that variables are used interchangeably elsewhere with variable name strings. |
twiecki
reviewed
Jul 25, 2018
| @@ -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 | |||
There was a problem hiding this comment.
shouldn't we call this varnames like elsewhere?
There was a problem hiding this comment.
If that's a general convention, I could put a new PR for this.
Also, a follow-up question that we could use to clarify the docstring - am I correct in thinking that sample_prior_predictive() will ignore any observations that are in the model? If so, we could extend the docstring to make this clear.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The previous docstring implied that the function received variables as parameter, and returned them as dictionary keys. But in fact, variable names are used everywhere.
A better fix might be to allow variables as well as variable names, but this is a quicker fix.