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.