pymc-devs/pymc

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

Open

#6.095 aberto em 2 de set. de 2022

Ver no GitHub
 (9 comments) (0 reactions) (0 assignees)Python (1.902 forks)batch import
docshelp wanted

Métricas do repositório

Stars
 (7.926 stars)
Métricas de merge de PR
 (Mesclagem média 11d 6h) (12 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Revise a discussão nesta issue e no PR vinculado #6080, particularmente a sugestão de @ricardoV94 para usar a terminologia 'tensor like'. Examine como 'tensor like' é atualmente usado nas docstrings e na base de código do PyMC. Proponha um termo consistente para distribuições sem nome (por exemplo, em pm.AR, pm.Mixture) e defina o claramente. Considere outros tipos de argumentos ambíguos que possam se beneficiar de uma nomenclatura semelhante.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Precisa de investigação
Prerequisites
basic understanding of PyMCfamiliarity with distribution docstrings
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40