pymc-devs/pymc

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

Open

#6854 aperta il 11 ago 2023

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)Python (1902 fork)batch import
docshelp wanted

Metriche repository

Star
 (7926 star)
Metriche merge PR
 (Merge medio 11g 6h) (12 PR mergiate in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Esamina il file di configurazione di Sphinx (probabilmente docs/conf.py) per vedere come i moduli vengono documentati automaticamente o esclusi. Controlla il modulo pm.sampling.jax init .py e i docstring per assicurarti che siano formattati correttamente. Verifica se ci sono direttive o estensioni autodoc esistenti che potrebbero saltare questo modulo. Considera di testare la build localmente dopo aver aggiunto il modulo all'elenco autodoc.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Sphinx documentation setupPyMC JAX module structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70