pymc-devs/pymc

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

Open

#6.854 geöffnet am 11. Aug. 2023

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.902 Forks)batch import
docshelp wanted

Repository-Metriken

Stars
 (7.926 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 11T 6h) (12 gemergte PRs in 30 T)

Beschreibung

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?

Contributor Guide

Research-Richtung
Überprüfen Sie die Sphinx Konfigurationsdatei (wahrscheinlich docs/conf.py), um zu sehen, wie Module automatisch dokumentiert oder ausgeschlossen werden. Überprüfen Sie die init .py und Docstrings des Moduls pm.sampling.jax, um sicherzustellen, dass sie korrekt formatiert sind. Prüfen Sie, ob es vorhandene autodoc Direktiven oder Erweiterungen gibt, die dieses Modul möglicherweise überspringen. Erwägen Sie, den Build lokal zu testen, nachdem Sie das Modul zur autodoc Liste hinzugefügt haben.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Sphinx documentation setupPyMC JAX module structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70