hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-06 10:31:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update Ray client docs (#14422)

Browse source
This commit is contained in:
Eric Liang 2021-03-01 14:08:34 -08:00 • committed by GitHub
parent 9db000ff2c
commit eab53a8808
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc/source/ray-client.rst
View file

@ -4,10 +4,6 @@
Ray Client
**********
.. note::
This feature is still in beta and subject to changes.
===========
Basic usage
===========
@ -39,16 +35,10 @@ From here, another Ray script can access that server from a networked machine wi
When the client disconnects, any object or actor references held by the server on behalf of the client are dropped, as if directly disconnecting from the cluster.
============
Known issues
============
=======================
Versioning requirements
=======================
Because Ray client mode affects the behavior of the Ray API, larger scripts or libraries imported before ``ray.util.connect()`` may not realize they're in client mode. This feature is being tracked with `issue #13272 <https://github.com/ray-project/ray/issues/13272>`_ but the workaround here is provided for beta users.
Generally, the client Ray version must match the server Ray version. An error will be raised if an incompatible version is used.
One option is to defer the imports from a ``main`` script that calls ``ray.util.connect()`` first. However, some older scripts or libraries might not support that.
Therefore, an environment variable is also available to force a Ray program into client mode: ``RAY_CLIENT_MODE`` An example usage:
.. code-block:: bash
RAY_CLIENT_MODE=1 python my_ray_program.py
Similarly, the minor Python (e.g., 3.6 vs 3.7) must match between the client and server. An error will be raised if this is not the case.