facebookresearch/hydra

Add a standalone page describing @hydra.main() in details.

Open

#845 aberto em 5 de ago. de 2020

Ver no GitHub
 (4 comments) (2 reactions) (0 assignees)Python (608 forks)batch import
documentationgood first issue

Métricas do repositório

Stars
 (7.539 stars)
Métricas de merge de PR
 (Mesclagem média 37d 6h) (25 fundiu PRs em 30d)

Description

Input from @omry : There are many details that does not fit into the tutorial.

  • the behavior of the return value.
  • support for config passthrough
  • detailed documentation of the parameters

Guia do colaborador

Direção de pesquisa
Familiarize se com a estrutura da documentação do Hydra e crie uma nova página independente cobrindo o comportamento do valor de retorno, suporte para passagem de configuração e documentação detalhada dos parâmetros do @hydra.main(). Veja as páginas de documentação existentes para estilo e formato.
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.
Meio dia
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