index.rst 1.16 KB
Newer Older
1
.. FairScale documentation master file, created by
2
   sphinx-quickstart on Tue Sep  8 16:19:17 2020.
Min Xu's avatar
Min Xu committed
3
4
5
   You can adapt this file completely to your liking,
   but it should at least contain the root `toctree`
   directive.
6

7
8
FairScale Documentation
=======================
9

10
11
12
FairScale is a PyTorch extension library for high performance and large scale training. 
FairScale makes available the latest distributed training techniques in the form of composable 
modules and easy to use APIs.
13

14
15
16
.. toctree::
   :maxdepth: 1
   :caption: Index
17

18
19
20
21
22
   what_is_fairscale
   getting_started
   blogs_and_press
   getting_involved
   integrations
23

24
25
|
|
msbaines's avatar
msbaines committed
26

27
28
29
.. toctree::
   :maxdepth: 1
   :caption: Installation
30

31
   installation_instructions
32

33
34
|
|
35

36
37
38
.. toctree::
   :maxdepth: 1
   :caption: Deep Dive
39

40
41
42
43
44
   deep_dive/oss_sdp_fsdp
   deep_dive/offload
   deep_dive/adascale
   deep_dive/pipeline_parallelism
   deep_dive/activation_checkpointing
45

46
47
|
|
48

49
.. toctree::
50
51
   :maxdepth: 1
   :caption: Tutorials
52

53
54
55
56
57
   tutorials/oss
   tutorials/activation_checkpointing
   tutorials/offload_model
   tutorials/adascale
   tutorials/pipe
58

59
60
|
|
61

62
63
64
.. toctree::
   :maxdepth: 1
   :caption: API Documentation
65

66
   api/index