pymc-devs/pymc

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

Aberta

#6.854 aberto em 11 de ago. de 2023

Ver no GitHubGuia do colaborador
 (5 comentários) (0 reação) (0 responsável)Python (1.902 forks)batch import
docshelp wanted

Métricas do repositório

Stars
 (7.926 estrelas)
Métricas de merge de PR
 (Mesclagem média 11d) (7 fundiu PRs em 30d)

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?

Guia do colaborador

Direção de pesquisa
Localize o arquivo de configuração do Sphinx que gera a documentação da API e adicione o módulo pm.sampling.jax às diretivas autodoc.
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85