facebookresearch/hydra

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

Aperta

#845 aperta il 5 ago 2020

Vedi su GitHubGuida contributor
 (4 commenti) (2 reazioni) (0 assegnatari)Python (608 fork)batch import
documentationgood first issuetriage

Metriche repository

Star
 (7539 stelle)
Metriche merge PR
 (Merge medio 37g 6h) (25 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Familiarizzati con la struttura della documentazione di Hydra, quindi crea una nuova pagina autonoma che copra il comportamento del valore di ritorno, il supporto per il passaggio di configurazione e la documentazione dettagliata dei parametri per @hydra.main(). Guarda le pagine di documentazione esistenti per stile e formato.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85