Skip to content
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

DOC: pymc.sample replaced by pymc.sampling.mcmc.sample in the documention #7070

Open
HumphreyYang opened this issue Dec 20, 2023 · 4 comments · May be fixed by #7072
Open

DOC: pymc.sample replaced by pymc.sampling.mcmc.sample in the documention #7070

HumphreyYang opened this issue Dec 20, 2023 · 4 comments · May be fixed by #7072
Labels

Comments

@HumphreyYang
Copy link

HumphreyYang commented Dec 20, 2023

Issue with current documentation:

pymc.sample was replaced by pymc.sampling.mcmc.sample in the documentation after v.5.10.0, but pymc.sample can still be called under pymc-5.10.2.

Idea or request for content:

No response

Copy link

welcome bot commented Dec 20, 2023

Welcome Banner
🎉 Welcome to PyMC! 🎉 We're really excited to have your input into the project! 💖

If you haven't done so already, please make sure you check out our Contributing Guidelines and Code of Conduct.

@OriolAbril
Copy link
Member

Everything should be documented at the path we expect users to use the object from. Here it is very clearly pymc.sample.

This was one of the main efforts in improving the docs between v3 and v4, and doing it well allows code samples (in pymc-examples among others) to automatically add links to the docs within the rendered code blocks.

@HumphreyYang
Copy link
Author

Many thanks for your reply @OriolAbril.

Everything should be documented at the path we expect users to use the object from. Here it is very clearly pymc.sample.

So in case, if I understand correctly, the documentation should change the pymc.sampling.mcmc.sample back to pymc.sample like versions prior to 5.10.1, which is the path users should use.

@OriolAbril
Copy link
Member

Exactly, not only pymc.sample though, most functions in the sampling page need to be corrected. Are you interested in sending a PR to fix it?

@HumphreyYang HumphreyYang linked a pull request Dec 22, 2023 that will close this issue
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants