Skip to content

Clean up docstring for sample. #3586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 14, 2019

Conversation

rpgoldman
Copy link
Contributor

Simple clarifications to documentation for step argument.

Copy link
Member

@fonnesbeck fonnesbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not exactly true. NUTS is only chosen for continuous variables.

@rpgoldman
Copy link
Contributor Author

@fonnesbeck

This is not exactly true. NUTS is only chosen for continuous variables.

How about

By default the NUTS step method will be used, if applicable; this is a good default for beginning users.

This is the behavior most people will see, and the "if applicable" gives us an out. The details of step function choice for more complex cases is probably too much to go into in a docstring. Maybe we should have a bigger discussion (that I am not competent to write!) on the web page?

@fonnesbeck
Copy link
Member

Yeah, that's better. Or "if suitable for the model".

@rpgoldman
Copy link
Contributor Author

rpgoldman commented Aug 13, 2019 via email

@rpgoldman
Copy link
Contributor Author

Should be good to go now.

@fonnesbeck fonnesbeck merged commit c1b9272 into pymc-devs:master Aug 14, 2019
@rpgoldman rpgoldman deleted the sample-docstring branch August 14, 2019 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants