index.rst

.. FairScale documentation master file, created by
   sphinx-quickstart on Tue Sep  8 16:19:17 2020.
   You can adapt this file completely to your liking,
   but it should at least contain the root `toctree`
   directive.

FairScale Documentation
=======================

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.

.. toctree::
   :maxdepth: 1
   :caption: Index

   what_is_fairscale
   getting_started
   blogs_and_press
   getting_involved
   integrations

|
|

.. toctree::
   :maxdepth: 1
   :caption: Installation

   installation_instructions

|
|

.. toctree::
   :maxdepth: 1
   :caption: Deep Dive

   deep_dive/oss_sdp_fsdp
   deep_dive/offload
   deep_dive/adascale
   deep_dive/pipeline_parallelism
   deep_dive/activation_checkpointing
   deep_dive/slowmo_ddp

|
|

.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   tutorials/oss
   tutorials/activation_checkpointing
   tutorials/offload_model
   tutorials/adascale
   tutorials/pipe
   tutorials/layer_memory_tracking
   tutorials/slowmo_ddp

|
|

.. toctree::
   :maxdepth: 1
   :caption: API Documentation

   api/index