Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
fairscale
Commits
41819af9
Unverified
Commit
41819af9
authored
Sep 24, 2020
by
Vittorio Caggiano
Committed by
GitHub
Sep 24, 2020
Browse files
Update README.md (#110)
add badges and link to readthedoc
parent
274478d0
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
33 additions
and
21 deletions
+33
-21
README.md
README.md
+33
-21
No files found.
README.md
View file @
41819af9
# fairscale
fairscale is a PyTorch extension library for high performance and large scale training.

[

](https://fairscale.readthedocs.io/en/latest/?badge=latest)
[

](https://app.circleci.com/pipelines/github/facebookresearch/fairscale/) !
[
PyPI - License
](
https://img.shields.io/pypi/l/fairscale
)
[
![PRs Welcome
]
(https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/facebookresearch/fairscale/blob/master/CONTRIBUTING.md)
## Description
fairscale is a PyTorch extension library for high performance and large scale training for optimizing training on one or across multiple machines/nodes. This library extend basic pytorch capabilities while adding new experimental ones.
fairscale supports:
*
pipeline parallelism (fairscale.nn.Pipe)
*
tensor parallelism (fairscale.nn.model_parallel)
*
optimizer state sharding (fairscale.optim.oss)
*
Parallelism:
*
pipeline parallelism (fairscale.nn.Pipe)
*
tensor parallelism (fairscale.nn.model_parallel)
*
Optimization:
*
optimizer state sharding (fairscale.optim.oss)
## Requirements
*
PyTorch >= 1.4
## Installation
Normal installation:
```
bash
pip
install
fairscale
```
Development mode:
```
bash
cd
fairscale
pip
install
-r
requirements.txt
pip
install
-e
.
```
## Getting Started
The full documentation (https://fairscale.readthedocs.io/) contains instructions for getting started and extending fairscale.
## Examples
### Pipe
...
...
@@ -72,23 +101,6 @@ if __name__ == "__main__":
```
## Requirements
*
PyTorch >= 1.4
## Installation
Normal installation:
```
bash
pip
install
fairscale
```
Development mode:
```
bash
cd
fairscale
pip
install
-r
requirements.txt
pip
install
-e
.
```
# Testing
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment