mirror of
https://github.com/vale981/ray
synced 2025-03-09 04:46:38 -04:00
515da7721a
* Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
49 lines
883 B
ReStructuredText
49 lines
883 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 create_or_update
|
|
:show-nested:
|
|
|
|
.. click:: ray.scripts.scripts:teardown
|
|
:prog: ray teardown
|
|
:show-nested:
|
|
|
|
.. click:: ray.scripts.scripts:get_head_ip
|
|
:prog: ray get_head_ip
|
|
:show-nested:
|