ContinualAI/avalanche

Examples in the documentation

Open

#886 ouverte le 20 janv. 2022

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Python (258 forks)batch import
Feature - Medium Prioritydocumentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (1 516 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez la structure de la documentation existante et identifiez les classes de haut niveau et les fonctionnalités les plus utilisées. Créez ensuite des extraits d'exemple similaires au style de documentation de PyTorch.
Stack technique
pythonpytorch
Domaine
documentationmachine learning
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonPyTorch
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85