pymc-devs/pymc

DOC: pm.sampling.jax functions are not included in PyMC docs

Open

#6854 opened on Aug 11, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (7,926 stars) (1,902 forks)batch import
docshelp wanted

Description

Issue with current documentation:

Various functions made available via pm.sampling.jax, including sample_numpyro_nuts() and sample_blackjax_nuts() do not appear in the documentation despite these functions having docstrings. Maybe we didn't include the pm.sampling.jax module is some auto-docing because it was a bit experimental at the time?

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Sphinx documentation setupPyMC JAX module structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the Sphinx configuration file (likely docs/conf.py) to see how modules are auto documented or excluded. Look at the pm.sampling.jax module's init .py and docstrings to ensure they are properly formatted. Check if there are any existing autodoc directives or extensions that may be skipping this module. Consider testing the build locally after adding the module to the autodoc list.