ContinualAI/avalanche

Examples in the documentation

Open

#886 geöffnet am 20. Jan. 2022

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (258 Forks)batch import
Feature - Medium Prioritydocumentationgood first issuehelp wanted

Repository-Metriken

Stars
 (1.516 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Dokumentationsstruktur und identifizieren Sie hochrangige Klassen und häufig verwendete Funktionen. Erstellen Sie dann Beispielsnippets im Stil der PyTorch Dokumentation.
Tech Stack
pythonpytorch
Domain
documentationmachine learning
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonPyTorch
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85