Updating docs - Added an example to sampling and added sampling to the docs #1970
Conversation
This file contains hidden or 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
aseyboldt
reviewed
Mar 29, 2017
| @@ -0,0 +1,8 @@ | |||
| ***** | |||
There was a problem hiding this comment.
You need to add new files to the toctree in source/api.rst, or they won't show up in the documentation.
docs/source/api/sampling.rst
Outdated
| @@ -0,0 +1,8 @@ | |||
| ******** | |||
There was a problem hiding this comment.
This is already in inference.rst.
pymc3/sampling.py
Outdated
| .. code:: ipython | ||
| >>> with pm.Model() as model: | ||
| ... b0 = pm.Normal('b0', mu=0, sd=100) | ||
| ... yest = b0 * X |
There was a problem hiding this comment.
This doesn't do anything. Did you forget an observed var here?
pymc3/sampling.py
Outdated
| ... yest = b0 * X | ||
| ... | ||
| >>> with model: | ||
| ... trc = pm.sample(100) |
There was a problem hiding this comment.
I'd prefer trace = pm.sample(2000, tune=1000, njobs=4)
pymc3/sampling.py
Outdated
| @@ -149,6 +149,30 @@ def sample(draws, step=None, init='ADVI', n_init=200000, start=None, | |||
| ------- | |||
| trace : pymc3.backends.base.MultiTrace | |||
| A `MultiTrace` object that contains the samples. | |||
|
|
|||
| Examples | |||
There was a problem hiding this comment.
Good idea, that was definitely missing.
nit: bad indent
|
Updated this - thanks. |
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.
These can probably be moved around a bit.
#1968