ContinualAI/avalanche

Examples in the documentation

Open

#886 opened on Jan 20, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (1,516 stars) (258 forks)batch import
Feature - Medium Prioritydocumentationgood first issuehelp wanted

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.

Contributor guide

Tech stack
pythonpytorch
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonPyTorchAvalanche basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
First, review the documentation example provided in issue #885 to understand the expected format. Then, examine the high level classes in the Avalanche library (likely in the `avalanche` package) to identify which ones are most frequently used by end users. Follow the PyTorch documentation style for examples, ensuring each example is self contained and illustrates typical usage. Finally, update the docstrings accordingly.
Examples in the documentation · ContinualAI/avalanche#886 | Good First Issue