ContinualAI/avalanche

Examples in the documentation

Open

#886 aberto em 20 de jan. de 2022

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Python (258 forks)batch import
Feature - Medium Prioritydocumentationgood first issuehelp wanted

Métricas do repositório

Stars
 (1.516 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

We should add some examples in the classes documentation, at least for the high level classes and all the features more frequently used by the end user. I think pytorch documentation is really good at this (example) and most pytorch users expect the same quality.

See #885 for an example.

Guia do colaborador

Direção de pesquisa
Revise a estrutura da documentação existente e identifique as classes de alto nível e os recursos mais utilizados. Em seguida, crie trechos de exemplo semelhantes ao estilo da documentação do PyTorch.
Pilha de tecnologia
pythonpytorch
Domain
documentationmachine learning
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.
1-3 horas
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
PythonPyTorch
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85