Add explanation for compound step methods #3014
Conversation
|
Thanks for the PR! However, I think it is better to draft a doc instead of putting the information in the docstring. |
|
Thanks for the reply! I wonder if you could point me to some examples to give me an idea about the format and where should I put this doc? Sorry that I don't have much experience in writing documentations for packages and would really appreciate some help :-) |
|
You can have a look at this two PRs: For this doc, I suggest you to put a notebook in https://github.com/pymc-devs/pymc3/tree/master/docs/source/notebooks, and then index it in https://github.com/pymc-devs/pymc3/blob/master/docs/source/examples.rst under Howto |
pymc3/sampling.py
Outdated
| @@ -193,7 +193,21 @@ def sample(draws=500, step=None, init='auto', n_init=200000, start=None, trace=N | |||
| live_plot_kwargs=None, compute_convergence_checks=True, use_mmap=False, **kwargs): | |||
| """Draw samples from the posterior using the given step methods. | |||
|
|
|||
| Multiple step methods are supported via compound step methods. | |||
| Multiple step methods are supported via compound step methods. When compound steps are involved, it takes a list of | |||
There was a problem hiding this comment.
Please reverse these changes.
|
Look good to me mostly, could you please upgrade your pymc3 version to the newest one and rerun your notebook? |
pymc3/sampling.py
Outdated
| @@ -193,7 +193,7 @@ def sample(draws=500, step=None, init='auto', n_init=200000, start=None, trace=N | |||
| live_plot_kwargs=None, compute_convergence_checks=True, use_mmap=False, **kwargs): | |||
| """Draw samples from the posterior using the given step methods. | |||
|
|
|||
| Multiple step methods are supported via compound step methods. | |||
| Multiple step methods are supported via compound step methods. | |||
|
Thanks @huangy22! And congrats on the first contribution ;-) |
|
Thank you for all your help @junpenglao and @twiecki ! :-) |
Address the issue #2083.