Documentation for using Ray on a cluster. (ray-project#165)

c21 · Dec 30, 2016 · 84296c8 · 84296c8
1 parent 13ee0ef
commit 84296c8
Show file tree

Hide file tree

Showing 9 changed files with 137 additions and 660 deletions.
diff --git a/README.md b/README.md
@@ -55,6 +55,7 @@ estimate of pi (waiting until the computation has finished if necessary).
  - [Serialization in the Object Store](doc/serialization.md)
  - [Reusable Variables](doc/reusable-variables.md)
  - [Using Ray with TensorFlow](doc/using-ray-with-tensorflow.md)
+ - [Using Ray on a Cluster](doc/using-ray-on-a-cluster.md)
 
 ## Example Applications
 

diff --git a/doc/about-the-system.md b/doc/about-the-system.md
diff --git a/doc/cluster-api.rst b/doc/cluster-api.rst
diff --git a/doc/install-on-macosx.md b/doc/install-on-macosx.md
@@ -1,6 +1,6 @@
 # Installation on Mac OS X
 
-Ray should work with Python 2. We have tested Ray on OS X 10.11.
+Ray should work with Python 2 and Python 3. We have tested Ray on OS X 10.11.
 
 ## Dependencies
 
@@ -19,18 +19,19 @@ pip install --upgrade --verbose "git+git:https://github.com/ray-project/ray.git#egg=nu
 
 # Install Ray
 
-Ray can be installed with pip as follows.
+Ray can be built from the repository as follows.
 
 ```
-pip install --upgrade --verbose "git+git:https://github.com/ray-project/ray.git#egg=ray&subdirectory=lib/python"
+git clone https://github.com/ray-project/ray.git
+cd lib/python
+python setup.py install
 ```
 
-Alternatively, Ray can be built from the repository as follows.
+Alternatively, Ray can be installed with pip as follows. However, this is
+slightly less likely to succeed.
 
 ```
-git clone https://github.com/ray-project/ray.git
-cd lib/python
-python setup.py install
+pip install --upgrade --verbose "git+git:https://github.com/ray-project/ray.git#egg=ray&subdirectory=lib/python"
 ```
 
 ## Test if the installation succeeded

diff --git a/doc/install-on-ubuntu.md b/doc/install-on-ubuntu.md
@@ -1,6 +1,6 @@
 # Installation on Ubuntu
 
-Ray should work with Python 2. We have tested Ray on Ubuntu 14.04
+Ray should work with Python 2 and Python 3. We have tested Ray on Ubuntu 14.04
 and Ubuntu 16.04
 
 ## Dependencies
@@ -19,18 +19,19 @@ pip install --upgrade --verbose "git+git:https://github.com/ray-project/ray.git#egg=nu
 
 # Install Ray
 
-Ray can be installed with pip as follows.
+Ray can be built from the repository as follows.
 
 ```
-pip install --upgrade --verbose "git+git:https://github.com/ray-project/ray.git#egg=ray&subdirectory=lib/python"
+git clone https://github.com/ray-project/ray.git
+cd lib/python
+python setup.py install
 ```
 
-Alternatively, Ray can be built from the repository as follows.
+Alternatively, Ray can be installed with pip as follows. However, this is
+slightly less likely to succeed.
 
 ```
-git clone https://github.com/ray-project/ray.git
-cd lib/python
-python setup.py install
+pip install --upgrade --verbose "git+git:https://github.com/ray-project/ray.git#egg=ray&subdirectory=lib/python"
 ```
 
 ## Test if the installation succeeded

diff --git a/doc/reference-counting.md b/doc/reference-counting.md
diff --git a/doc/scheduler.md b/doc/scheduler.md