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.

Welcome to fairscale's documentation!
=====================================

.. toctree::
   :maxdepth: 3
   :caption: Contents:
   :hidden:

   tutorials/index
   api/index

*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.


Components
----------

* Parallelism:
   * `pipeline parallelism <../../build/html/api/nn/pipe.html>`_
   * `tensor parallelism <../../build/html/api/nn/model_parallel.html>`_
* Optimization:
   * `optimizer state sharding <../../build/html/api/optim/oss.html>`_


.. warning::
    This library is under active development. 
    Please be mindful and create an `issue <https://github.com/facebookresearch/fairscale/issues>`_ if you have any trouble and/or suggestion.


Reference
=========

:ref:`genindex` | :ref:`modindex` | :ref:`search`