mirror of
https://github.com/vale981/ray
synced 2025-03-06 10:31:39 -05:00
127 lines
3.9 KiB
ReStructuredText
127 lines
3.9 KiB
ReStructuredText
Installing Ray
|
|
==============
|
|
|
|
Ray should work with Python 2 and Python 3. We have tested Ray on Ubuntu 14.04, Ubuntu 16.04, OS X 10.11 and 10.12.
|
|
|
|
You can install Ray as follows.
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install ray
|
|
|
|
Trying the latest version of Ray
|
|
--------------------------------
|
|
|
|
Here are links to the latest wheels (which are built off of master). These versions will have newer
|
|
features but may be subject to more bugs. To install these wheels, run the following command:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install -U [link to wheel]
|
|
|
|
|
|
=================== ===================
|
|
Linux MacOS
|
|
=================== ===================
|
|
`Linux Python 3.6`_ `MacOS Python 3.6`_
|
|
`Linux Python 3.5`_ `MacOS Python 3.5`_
|
|
`Linux Python 3.4`_ `MacOS Python 3.4`_
|
|
`Linux Python 3.3`_
|
|
`Linux Python 2.7`_ `MacOS Python 2.7`_
|
|
=================== ===================
|
|
|
|
|
|
.. _`Linux Python 3.6`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-0.4.0-cp36-cp36m-manylinux1_x86_64.whl
|
|
.. _`Linux Python 3.5`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-0.4.0-cp35-cp35m-manylinux1_x86_64.whl
|
|
.. _`Linux Python 3.4`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-0.4.0-cp34-cp34m-manylinux1_x86_64.whl
|
|
.. _`Linux Python 3.3`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-0.4.0-cp33-cp33m-manylinux1_x86_64.whl
|
|
.. _`Linux Python 2.7`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-0.4.0-cp27-cp27mu-manylinux1_x86_64.whl
|
|
.. _`MacOS Python 3.6`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-0.4.0-cp36-cp36m-macosx_10_6_intel.whl
|
|
.. _`MacOS Python 3.5`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-0.4.0-cp35-cp35m-macosx_10_6_intel.whl
|
|
.. _`MacOS Python 3.4`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-0.4.0-cp34-cp34m-macosx_10_6_intel.whl
|
|
.. _`MacOS Python 2.7`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-0.4.0-cp27-cp27m-macosx_10_6_intel.whl
|
|
|
|
|
|
Building Ray from source
|
|
------------------------
|
|
|
|
If you want to use the latest version of Ray, you can build it from source. Below, we have instructions for installing dependencies and building from source for both Linux and MacOS.
|
|
|
|
Dependencies
|
|
~~~~~~~~~~~~
|
|
|
|
To build Ray, first install the following dependencies. We recommend using
|
|
`Anaconda`_.
|
|
|
|
.. _`Anaconda`: https://www.continuum.io/downloads
|
|
|
|
For Ubuntu, run the following commands:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo apt-get update
|
|
sudo apt-get install -y cmake pkg-config build-essential autoconf curl libtool unzip flex bison python # we install python here because python2 is required to build the webui
|
|
|
|
# If you are not using Anaconda, you need the following.
|
|
sudo apt-get install python-dev # For Python 2.
|
|
sudo apt-get install python3-dev # For Python 3.
|
|
|
|
# If you are on Ubuntu 14.04, you need the following.
|
|
pip install cmake
|
|
|
|
pip install cython
|
|
|
|
For MacOS, run the following commands:
|
|
|
|
.. code-block:: bash
|
|
|
|
brew update
|
|
brew install cmake pkg-config automake autoconf libtool openssl bison wget
|
|
|
|
pip install cython
|
|
|
|
|
|
If you are using Anaconda, you may also need to run the following.
|
|
|
|
.. code-block:: bash
|
|
|
|
conda install libgcc
|
|
|
|
|
|
Install Ray
|
|
~~~~~~~~~~~
|
|
|
|
Ray can be built from the repository as follows.
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://github.com/ray-project/ray.git
|
|
cd ray/python
|
|
pip install -e . --verbose # Add --user if you see a permission denied error.
|
|
|
|
Alternatively, Ray can be built from the repository without cloning using pip.
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install git+https://github.com/ray-project/ray.git#subdirectory=python
|
|
|
|
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.
|
|
|
|
.. code-block:: bash
|
|
|
|
python test/runtest.py
|
|
|
|
Cleaning the source tree
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The source tree can be cleaned by running
|
|
|
|
.. code-block:: bash
|
|
|
|
git clean -f -f -x -d
|
|
|
|
in the ``ray/`` directory.
|