ray/README.rst
Richard Liaw d482aa5aed Making our landing pages look better (#1022)
* Teaser in the front page of docs

* TEASER

* try changing README

* spacing

* readme

* power words

* readme obj_id change

* obj_ids change for docs

* Updates to readme.

* Update landing page in documentation.

* Fix linting.
2017-09-30 15:37:28 -07:00

62 lines
2.9 KiB
ReStructuredText

Ray
===
.. image:: https://travis-ci.org/ray-project/ray.svg?branch=master
:target: https://travis-ci.org/ray-project/ray
.. image:: https://readthedocs.org/projects/ray/badge/?version=latest
:target: http://ray.readthedocs.io/en/latest/?badge=latest
|
Ray is a flexible, high-performance distributed execution framework.
Installation
------------
- Ray can be installed on Linux and Mac with ``pip install ray``.
- To build Ray from source, see the instructions for `Ubuntu`_ and `Mac`_.
.. _`Ubuntu`: http://ray.readthedocs.io/en/latest/install-on-ubuntu.html
.. _`Mac`: http://ray.readthedocs.io/en/latest/install-on-macosx.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)] | object_ids = [f.remote() for i in range(4)] |
| | results = ray.get(object_ids) |
+------------------------------------------------+----------------------------------------------+
More Information
----------------
- `Mailing List`_
- `Documentation`_
- `Tutorial`_
- `Blog`_
- `Ray HotOS paper`_
.. _`Mailing List`: https://groups.google.com/forum/#!forum/ray-dev
.. _`Documentation`: http://ray.readthedocs.io/en/latest/index.html
.. _`Tutorial`: https://github.com/ray-project/tutorial
.. _`Blog`: https://ray-project.github.io/
.. _`Ray HotOS paper`: https://arxiv.org/abs/1703.03924