ContinualAI/avalanche

Examples in the documentation

Open

#886 opened on Jan 20, 2022

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

Repository metrics

Stars
 (1,516 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the existing documentation structure and identify high level classes and frequently used features. Then create example snippets similar to PyTorch's documentation style.
Tech stack
pythonpytorch
Domain
documentationmachine learning
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonPyTorch
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85