pymc-devs/pymc

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

Open

#6.095 geöffnet am 2. Sept. 2022

Auf GitHub ansehen
 (9 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

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.

Contributor Guide

Research-Richtung
Überprüfe die Diskussion in diesem Issue und dem verlinkten PR #6080, insbesondere den Vorschlag von @ricardoV94, die Terminologie 'tensor like' zu verwenden. Untersuche, wie 'tensor like' derzeit in den Docstrings und der Codebasis von PyMC verwendet wird. Schlage einen konsistenten Begriff für unbenannte Verteilungen (z. B. in pm.AR, pm.Mixture) vor und definiere ihn klar. Berücksichtige andere mehrdeutige Argumenttypen, die von einer ähnlichen Benennung profitieren könnten.
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.
3
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.
Recherche nötig
Voraussetzungen
basic understanding of PyMCfamiliarity with distribution docstrings
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40