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 (1,902 fork)batch import
docshelp wanted

仓库指标

Star
 (7,926 star)
PR 合并指标
 (平均合并 11天) (30 天内合并 7 个 PR)

描述

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?

贡献者指南

研究方向
找到生成API文档的Sphinx配置文件，并将pm.sampling.jax模块添加到autodoc指令中。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitPython
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85