Skip to content
Permalink
Browse files

Improve documentation build and reference (#1529)

Signed-off-by: Enrico Minack <github@enrico.minack.dev>
  • Loading branch information
EnricoMi authored and tgaddair committed Nov 25, 2019
1 parent 408dfde commit 3237ccc6d4bbc0b439cd9d18d8bffb4c9b2c8e4f
Showing with 34 additions and 1 deletion.
  1. +6 −0 README.rst
  2. +25 −0 docs/contributors.rst
  3. +2 −0 docs/summary.rst
  4. +1 −1 horovod/common/basics.py
@@ -52,8 +52,12 @@ about who's involved and how Horovod plays a role, read the LF AI `announcement

.. contents::


See the full documentation and an API reference at https://horovod.readthedocs.io/en/latest.

|


Why not traditional Distributed TensorFlow?
-------------------------------------------

@@ -116,6 +120,8 @@ If you're installing Horovod on a server with GPUs, read the `Horovod on GPU <do

If you want to use Docker, read the `Horovod in Docker <docs/docker.rst>`_ page.

To compile Horovod from source, follow the instructions in the `Contributor Guide <docs/contributors.rst>`_.


Concepts
--------
@@ -74,6 +74,31 @@ Horovod has unit tests for all frameworks you can run from the tests directory:
**IMPORTANT:** Some tests contain GPU-only codepaths that will be skipped if running without GPU support.


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

The Horovod documentation is published to https://horovod.readthedocs.io/.

Those HTML pages can be rendered from ``.rst`` files located in the `docs` directory.
You need to set up Sphinx before you compile the documentation the first time:

.. code-block:: bash
$ cd docs
$ pip install -r requirements.txt
$ make clean
Then you can build the HTML pages and open ``docs/_build/html/index.html``:

.. code-block:: bash
$ cd docs
$ make html
$ open _build/html/index.html
Sphinx can render the documentation in many other formats. Type ``make`` to get a list of available formats.


Adding Custom Operations
------------------------

@@ -111,6 +111,8 @@ If you're installing Horovod on a server with GPUs, read `Horovod on GPU <gpus.r

If you want to use Docker, read `Horovod in Docker <docker.rst>`_.

To compile Horovod from source, follow the instructions in the `Contributor Guide <contributors.rst>`_.


Concepts
--------
@@ -16,7 +16,7 @@
import atexit
import ctypes

import horovod.common.util as util
from horovod.common import util as util


class HorovodBasics(object):

0 comments on commit 3237ccc

Please sign in to comment.
You can’t perform that action at this time.