pymc-devs/pymc

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

Open

#6,854 opened on 2023年8月11日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Python (7,926 stars) (1,902 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.