Skip to content
This repository has been archived by the owner on Jan 6, 2023. It is now read-only.

Move torchelastic docs *.rst (#56811) #148

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ SPHINXBUILD = sphinx-build
SPHINXPROJ = torchelastic
SOURCEDIR = source
BUILDDIR = build
VERSION := $(shell python -c "import torchelastic; print(torchelastic.__version__)")
VERSION := "0.2.3.dev0"

# Put it first so that "make" without argument is like "make help".
help:
Expand Down
61 changes: 0 additions & 61 deletions docs/source/agent.rst

This file was deleted.

Binary file removed docs/source/agent_diagram.jpg
Binary file not shown.
4 changes: 1 addition & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import torch
import torchelastic
from docutils import nodes
from sphinx import addnodes
from sphinx.util.docfields import TypedField
Expand Down Expand Up @@ -88,7 +86,7 @@
#
# The short X.Y version.
# TODO: change to [:2] at v1.0
version = f"v{torchelastic.__version__}"
version = "v0.2.3.dev0"
# The full version, including alpha/beta/rc tags.
# TODO: verify this works as expected
release = "master"
Expand Down
118 changes: 0 additions & 118 deletions docs/source/customization.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/source/distributed.rst

This file was deleted.

17 changes: 0 additions & 17 deletions docs/source/errors.rst

This file was deleted.

Binary file removed docs/source/etcd_rdzv_diagram.png
Binary file not shown.
27 changes: 0 additions & 27 deletions docs/source/events.rst

This file was deleted.

49 changes: 7 additions & 42 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,49 +3,14 @@
TorchElastic
==================

Makes distributed PyTorch fault-tolerant and elastic.

Get Started
---------------
.. toctree::
:maxdepth: 1
:caption: Usage

quickstart
train_script
examples

Documentation
---------------

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

distributed
agent
multiprocessing
errors
rendezvous
timer
metrics
events

.. toctree::
:maxdepth: 1
:caption: Advanced

customization

.. toctree::
:maxdepth: 1
:caption: Plugins

kubernetes
runtime

.. important:: TorchElastic has been upstreamed to PyTorch (``torch.distributed.elastic``) and will be
included as part of the next PyTorch release (``torch-1.9``). In the meanwhile please use
`pytorch-nightly <https://pytorch.org/get-started/locally/#start-locally>`_ or
`torchelastic-0.2.2 <https://pypi.org/project/torchelastic/>`_. For documentation please refer to our
`v0.2.2 docs <https://pytorch.org/elastic/0.2.2>`_ for now.

Training Session Manager(TSM)
---------------
------------------------------
.. toctree::
:maxdepth: 1
:caption: Training Session Manager(TSM)
Expand Down
5 changes: 0 additions & 5 deletions docs/source/kubernetes.rst

This file was deleted.

31 changes: 0 additions & 31 deletions docs/source/metrics.rst

This file was deleted.

24 changes: 0 additions & 24 deletions docs/source/multiprocessing.rst

This file was deleted.

Loading