ray/doc/source/package-ref.rst
zhu-eric 65297e65f0 Experimental Actor Pool (#6055)
* mod_table

* Example fix for gallery

* lint

* nit

* nit

* fix

* gallery

* remove table for now

* training, object store, tune, actors, advanced

* start tf code

* first cut tf

* yapf

* pytorch

* add torch example

* torch

* parallel

* tune

* tuning

* reviewsready

* finetune

* fix

* move_code

* update conf

* compile

* init hyperparameter

* Start images

* overview

* extra

* fix

* works

* update-ps-example

* param_actor

* fix

* examples

* simple

* simplify_pong

* flake8 and run hyperopt

* add comments

* add comments

* add suggestion

* add suggestion

* suggestions

* add suggestion

* add suggestions

* fixed in wrong area

* last edit

* finish changes

* add line

* format

* reset

* tests and docs

* fix tests

* bazelify

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2019-12-26 14:35:10 -08:00

96 lines
1.7 KiB
ReStructuredText

Ray Package Reference
=====================
.. autofunction:: ray.init
.. autofunction:: ray.is_initialized
.. 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
Inspect the Cluster State
-------------------------
.. autofunction:: ray.nodes
.. autofunction:: ray.tasks
.. autofunction:: ray.objects
.. autofunction:: ray.timeline
.. autofunction:: ray.object_transfer_timeline
.. autofunction:: ray.cluster_resources
.. autofunction:: ray.available_resources
.. autofunction:: ray.errors
Experimental APIs
-----------------
.. automodule:: ray.experimental
:members:
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:submit
:prog: ray submit
: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:
.. click:: ray.scripts.scripts:stack
:prog: ray stack
:show-nested:
.. click:: ray.scripts.scripts:timeline
:prog: ray timeline
:show-nested: