pymc-devs/pymc

Doc string terminology for unnamed distributions created via .dist()

Open

#6 095 ouverte le 2 sept. 2022

Voir sur GitHub
 (9 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

When updating the docstrings for pm.AR() distribution class (https://github.com/pymc-devs/pymc/pull/6080), it became clear that we have no clean, unified way to refer to the "unnamed distribution" arguments taken by some distributions (e.g., time series, pm.Mixture, etc.). @ricardoV94 suggested adopting something like the "tensor_like" nomenclature used elsewhere. This issue is intended to start discussion about whether that's a good idea and, if so, what a good term might be. While we're at it, we might try and figure out if there are any other argument types that we might want to name.

Guide contributeur

Direction de recherche
Examinez la discussion dans cette issue et la PR liée #6080, en particulier la suggestion de @ricardoV94 d'utiliser la terminologie 'tensor like'. Étudiez comment 'tensor like' est actuellement utilisé dans les docstrings et la base de code de PyMC. Proposez un terme cohérent pour les distributions sans nom (par exemple, dans pm.AR, pm.Mixture) et définissez le clairement. Considérez d'autres types d'arguments ambigus qui pourraient bénéficier d'une dénomination similaire.
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.
3
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.
Investigation requise
Prérequis
basic understanding of PyMCfamiliarity with distribution docstrings
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40