pymc-devs/pymc

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

Open

#6 854 ouverte le 11 août 2023

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)Python (1 902 forks)batch import
docshelp wanted

Métriques du dépôt

Stars
 (7 926 stars)
Métriques de merge PR
 (Merge moyen 11j 6h) (12 PRs mergées en 30 j)

Description

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?

Guide contributeur

Direction de recherche
Examinez le fichier de configuration Sphinx (probablement docs/conf.py) pour voir comment les modules sont documentés automatiquement ou exclus. Vérifiez le module pm.sampling.jax init .py et les docstrings pour vous assurer qu'ils sont correctement formatés. Vérifiez s'il existe des directives ou extensions autodoc existantes qui pourraient ignorer ce module. Envisagez de tester la construction localement après avoir ajouté le module à la liste autodoc.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Sphinx documentation setupPyMC JAX module structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70