Skip to content

Commit

Permalink
[docs] Add backlinks from hyperopt / rl algorithm examples to the bui…
Browse files Browse the repository at this point in the history
…lt-on Ray libraries (ray-project#1356)
  • Loading branch information
ericl authored and richardliaw committed Dec 23, 2017
1 parent 43e7821 commit 715737c
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
/src/common/format/*_generated.h
/src/plasma/format/*_generated.h
/src/local_scheduler/format/*_generated.h
/src/ray/gcs/format/*_generated.h

# Redis temporary files
*dump.rdb
Expand Down
4 changes: 4 additions & 0 deletions doc/source/example-a3c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ View the `code for this example`_.
.. _`Universe Starter Agent`: https://github.com/openai/universe-starter-agent
.. _`code for this example`: https://github.com/ray-project/ray/tree/master/python/ray/rllib/a3c

.. note::

For an overview of Ray's reinforcement learning library, see `Ray RLlib <http://ray.readthedocs.io/en/latest/rllib.html>`__.

To run the application, first install **ray** and then some dependencies:

.. code-block:: bash
Expand Down
5 changes: 5 additions & 0 deletions doc/source/example-hyperopt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@ Hyperparameter Optimization
===========================

This document provides a walkthrough of the hyperparameter optimization example.

.. note::

To learn about Ray's built-in hyperparameter optimization framework, see `Ray.tune <http://ray.readthedocs.io/en/latest/tune.html>`__.

To run the application, first install some dependencies.

.. code-block:: bash
Expand Down
5 changes: 5 additions & 0 deletions doc/source/example-policy-gradient.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ Policy Gradient Methods
This code shows how to do reinforcement learning with policy gradient methods.
View the `code for this example`_.

.. note::

For an overview of Ray's reinforcement learning library, see `Ray RLlib <http://ray.readthedocs.io/en/latest/rllib.html>`__.


To run this example, you will need to install `TensorFlow with GPU support`_ (at
least version ``1.0.0``) and a few other dependencies.

Expand Down

0 comments on commit 715737c

Please sign in to comment.