pymc-devs/pymc

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

Ouverte

#6 854 ouverte le 11 août 2023

Voir sur GitHubGuide contributeur
 (5 commentaires) (0 réaction) (0 personne assignée)Python (1 902 forks)batch import
docshelp wanted

Métriques du dépôt

Stars
 (7 926 étoiles)
Métriques de merge PR
 (Merge moyen 11j) (7 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
Localisez le fichier de configuration Sphinx qui genere la documentation de l'API et ajoutez le module pm.sampling.jax aux directives 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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85