pymc-devs/pymc

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

Open

#6,854 创建于 2023年8月11日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)Python (7,926 star) (1,902 fork)batch import
docshelp wanted

描述

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?

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Sphinx documentation setupPyMC JAX module structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.