ContinualAI/avalanche

Examples in the documentation

Open

#886 aperta il 20 gen 2022

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (258 fork)batch import
Feature - Medium Prioritydocumentationgood first issuehelp wanted

Metriche repository

Star
 (1516 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi la struttura della documentazione esistente e identifica le classi di alto livello e le funzionalità più usate. Poi crea snippet di esempio simili allo stile della documentazione di PyTorch.
Tech stack
pythonpytorch
Dominio
documentationmachine learning
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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
PythonPyTorch
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85