ray/doc/source/index.rst
Eric Liang 35f7398666
[rllib] Update RLlib docs and README (#1288)
Updates the rllib docs and README.
2017-12-06 18:17:51 -08:00

96 lines
3.3 KiB
ReStructuredText

Ray
===
*Ray is a flexible, high-performance distributed execution framework.*
Ray comes with libraries that accelerate deep learning and reinforcement learning development:
- `Ray.tune`_: Efficient Distributed Hyperparameter Search
- `Ray RLlib`_: A Composable and Scalable Reinforcement Learning Library
.. _`Ray.tune`: tune.html
.. _`Ray RLlib`: rllib.html
Example Program
---------------
+------------------------------------------------+----------------------------------------------------+
| **Basic Python** | **Distributed with Ray** |
+------------------------------------------------+----------------------------------------------------+
|.. code:: python |.. code-block:: python |
| | |
| import time | import time |
| | import ray |
| | |
| | ray.init() |
| | |
| | @ray.remote |
| def f(): | def f(): |
| time.sleep(1) | time.sleep(1) |
| return 1 | return 1 |
| | |
| # Execute f serially. | # Execute f in parallel. |
| results = [f() for i in range(4)] | results = ray.get([f.remote() for i in range(4)]) |
+------------------------------------------------+----------------------------------------------------+
.. toctree::
:maxdepth: 1
:caption: Installation
install-on-ubuntu.rst
install-on-macosx.rst
install-on-docker.rst
installation-troubleshooting.rst
.. toctree::
:maxdepth: 1
:caption: Getting Started
tutorial.rst
api.rst
actors.rst
using-ray-with-gpus.rst
tune.rst
rllib.rst
webui.rst
.. toctree::
:maxdepth: 1
:caption: Examples
example-hyperopt.rst
example-rl-pong.rst
example-policy-gradient.rst
example-parameter-server.rst
example-resnet.rst
example-a3c.rst
example-lbfgs.rst
example-evolution-strategies.rst
example-cython.rst
example-streaming.rst
using-ray-with-tensorflow.rst
.. toctree::
:maxdepth: 1
:caption: Design
internals-overview.rst
serialization.rst
fault-tolerance.rst
plasma-object-store.rst
resources.rst
.. toctree::
:maxdepth: 1
:caption: Cluster Usage
using-ray-on-a-cluster.rst
using-ray-on-a-large-cluster.rst
using-ray-and-docker-on-a-cluster.md
.. toctree::
:maxdepth: 1
:caption: Help
troubleshooting.rst
contact.rst