ray/doc/source/api.rst
Eric Liang 079c4e482a
ray exec and ray attach commands (#2560)
ray exec CLUSTER CMD [--screen] [--start] [--stop]
ray attach CLUSTER [--start]

Example:
ray exec sgd.yaml 'source activate tensorflow_p27 && cd ~/ray/python/ray/rllib && ./train.py --run=PPO --env=CartPole-v0' --screen --start --stop

This will in one command create a cluster and run the command on it in a screen session. The screen can later be attached to via ray attach. After the command finishes, the cluster workers will be terminated and the head node stopped.
2018-08-15 14:31:50 -07:00

57 lines
1,019 B
ReStructuredText

The Ray API
===========
.. autofunction:: ray.init
.. autofunction:: ray.remote
.. autofunction:: ray.get
.. autofunction:: ray.wait
.. autofunction:: ray.put
.. autofunction:: ray.get_gpu_ids
.. autofunction:: ray.get_resource_ids
.. autofunction:: ray.get_webui_url
.. autofunction:: ray.shutdown
.. autofunction:: ray.register_custom_serializer
.. autofunction:: ray.profile
.. autofunction:: ray.method
The Ray Command Line API
------------------------
.. click:: ray.scripts.scripts:start
:prog: ray start
:show-nested:
.. click:: ray.scripts.scripts:stop
:prog: ray stop
:show-nested:
.. click:: ray.scripts.scripts:create_or_update
:prog: ray up
:show-nested:
.. click:: ray.scripts.scripts:teardown
:prog: ray down
:show-nested:
.. click:: ray.scripts.scripts:exec_cmd
:prog: ray exec
:show-nested:
.. click:: ray.scripts.scripts:attach
:prog: ray attach
:show-nested:
.. click:: ray.scripts.scripts:get_head_ip
:prog: ray get_head_ip
:show-nested: