Update installation documentation to recommend installing Ray with pip. (#637)

This commit is contained in:
Robert Nishihara
2017-06-07 05:51:06 +00:00
committed by Philipp Moritz
parent 60161f276b
commit fde843a636
2 changed files with 34 additions and 12 deletions
+17 -6
View File
@@ -4,10 +4,21 @@ Installation on Mac OS X
Ray should work with Python 2 and Python 3. We have tested Ray on OS X 10.11 and
10.12.
Dependencies
------------
You can install Ray as follows.
To install Ray, first install the following dependencies. We recommend using
.. code-block:: bash
pip install ray
Building Ray from source
------------------------
If you want to use the latest version of Ray, you can build it from source.
Dependencies
~~~~~~~~~~~~
To build Ray, first install the following dependencies. We recommend using
`Anaconda`_.
.. _`Anaconda`: https://www.continuum.io/downloads
@@ -27,7 +38,7 @@ If you are using Anaconda, you may also need to run the following.
Install Ray
-----------
~~~~~~~~~~~
Ray can be built from the repository as follows.
@@ -35,11 +46,11 @@ Ray can be built from the repository as follows.
git clone https://github.com/ray-project/ray.git
cd ray/python
python setup.py install --user
python setup.py install
Test if the installation succeeded
----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To test if the installation was successful, try running some tests. This assumes
that you've cloned the git repository.
+17 -6
View File
@@ -4,10 +4,21 @@ Installation on Ubuntu
Ray should work with Python 2 and Python 3. We have tested Ray on Ubuntu 14.04
and Ubuntu 16.04.
Dependencies
------------
You can install Ray as follows.
To install Ray, first install the following dependencies. We recommend using
.. code-block:: bash
pip install ray
Building Ray from source
------------------------
If you want to use the latest version of Ray, you can build it from source.
Dependencies
~~~~~~~~~~~~
To build Ray, first install the following dependencies. We recommend using
`Anaconda`_.
.. _`Anaconda`: https://www.continuum.io/downloads
@@ -32,7 +43,7 @@ If you are using Anaconda, you may also need to run the following.
Install Ray
-----------
~~~~~~~~~~~
Ray can be built from the repository as follows.
@@ -40,11 +51,11 @@ Ray can be built from the repository as follows.
git clone https://github.com/ray-project/ray.git
cd ray/python
python setup.py install --user
python setup.py install
Test if the installation succeeded
----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To test if the installation was successful, try running some tests. This assumes
that you've cloned the git repository.