pymc-devs/pymc

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

Open

#6095 aperta il 2 set 2022

Vedi su GitHub
 (9 commenti) (0 reazioni) (0 assegnatari)Python (1902 fork)batch import
docshelp wanted

Metriche repository

Star
 (7926 star)
Metriche merge PR
 (Merge medio 11g 6h) (12 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi la discussione in questo issue e nella PR collegata #6080, in particolare il suggerimento di @ricardoV94 di utilizzare la terminologia 'tensor like'. Esamina come 'tensor like' è attualmente utilizzato nelle docstring e nel codice di PyMC. Proponi un termine coerente per le distribuzioni senza nome (ad es. in pm.AR, pm.Mixture) e definiscilo chiaramente. Considera altri tipi di argomenti ambigui che potrebbero beneficiare di una denominazione simile.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Richiede indagine
Prerequisiti
basic understanding of PyMCfamiliarity with distribution docstrings
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40