facebookresearch / facebookresearch/fairscale

[Minor] Add some perf numbers to the readme or doc

Open
#213 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
3.4k
Forks
293
PR merge metrics
No merged PRs in 30d

Description

## 🚀 Feature
Add some performance numbers to either the doc or the README (or a dedicated sub-README). That could apply to Pipe or ShardedOptimizer

## Motivation
People landing on this repo probably would love to know more about the practical implications

## Pitch
Just add 2 examples per technique for instance, baseline with caveats

## Alternatives
Not doing anything

## Additional context
cc @Vittorio-Caggiano

Contributor guide

Open the contributing guide

Research direction

Start by locating the README or documentation sections for Pipe and ShardedOptimizer. Gather two practical performance examples per technique against a stated baseline, record caveats, and publish the results in the README, documentation, or a dedicated sub-README.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, performance
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.