pymc-devs/pymc

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

Open

#6.854 aberto em 11 de ago. de 2023

Ver no GitHub
 (5 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

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
Examine o arquivo de configuração do Sphinx (provavelmente docs/conf.py) para ver como os módulos são documentados automaticamente ou excluídos. Verifique o módulo pm.sampling.jax init .py e docstrings para garantir que estejam formatados corretamente. Verifique se há quaisquer diretivas ou extensões autodoc existentes que possam estar ignorando este módulo. Considere testar a construção localmente após adicionar o módulo à lista 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.
2
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.
Claro
Prerequisites
Sphinx documentation setupPyMC JAX module structure
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70