pymc icon indicating copy to clipboard operation
pymc copied to clipboard

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

Open HumphreyYang opened this issue 1 year ago • 4 comments

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

HumphreyYang avatar Dec 20 '23 05:12 HumphreyYang

Welcome Banner :tada: Welcome to PyMC! :tada: We're really excited to have your input into the project! :sparkling_heart:
If you haven't done so already, please make sure you check out our Contributing Guidelines and Code of Conduct.

welcome[bot] avatar Dec 20 '23 05:12 welcome[bot]

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.

OriolAbril avatar Dec 20 '23 17:12 OriolAbril

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.

HumphreyYang avatar Dec 22 '23 00:12 HumphreyYang

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?

OriolAbril avatar Dec 22 '23 09:12 OriolAbril