Skip to content

Commit

Permalink
Update documentation for OpenMPI (#437)
Browse files Browse the repository at this point in the history
* Update documentation

* Fix hyperlink in changelog

* Restore OpenMPI label

* Update README.md
  • Loading branch information
AdamGleave authored and araffin committed Aug 6, 2019
1 parent 3e8b5c1 commit 63f208e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,12 @@ brew install cmake openmpi
To install stable-baselines on Windows, please look at the [documentation](https://stable-baselines.readthedocs.io/en/master/guide/install.html#prerequisites).

### Install using pip
Install the Stable Baselines package
Install the Stable Baselines package:
```
pip install stable-baselines[mpi]
```

Using pip from pypi:
This includes an optional dependency on MPI, enabling algorithms DDPG, GAIL, PPO1 and TRPO. If you do not need these algorithms, you can install without MPI:
```
pip install stable-baselines
```
Expand Down
21 changes: 10 additions & 11 deletions docs/guide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,28 +47,27 @@ We recommend using `Anaconda <https://conda.io/docs/user-guide/install/windows.h
(using again ``pip install -e .``)


.. _openmpi:

Stable Release
--------------
~~~~~~~~~~~~~~
To install with support for all algorithms, including those depending on OpenMPI, execute:

.. code-block:: bash
pip install stable-baselines
.. _openmpi:
pip install stable-baselines[mpi]
Stable Release with OpenMPI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GAIL, DDPG, TRPO, and PPO1 parallelize training using OpenMPI. OpenMPI has had weird
interactions with Tensorflow in the past (see
`Issue #430 <https://github.com/hill-a/stable-baselines/issues/430>`) and so is disabled by
default.
`Issue #430 <https://github.com/hill-a/stable-baselines/issues/430>`_) and so if you do not
intend to use these algorithms we recommend installing without OpenMPI. To do this, execute:

.. code-block:: bash
pip install stable-baselines[mpi]
pip install stable-baselines
To disable OpenMPI, uninstall ``mpi4py`` with ``pip uninstall mpi4py``.
If you have already installed with MPI support, you can disable MPI by uninstalling ``mpi4py``
with ``pip uninstall mpi4py``.


Bleeding-edge version
Expand Down

0 comments on commit 63f208e

Please sign in to comment.