hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-09 04:46:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
ray/doc/source/package-ref.rst

254 lines
3.4 KiB
ReStructuredText
Raw Normal View History

[docs] rewrite (#5175)
2019-08-05 23:33:14 -07:00
Ray Package Reference
=====================
Move documentation to ReadTheDocs. (#326)
2017-02-27 21:14:31 -08:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
Python API
----------
.. _ray-init-ref:
ray.init
~~~~~~~~
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
.. autofunction:: ray.init
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-is_initialized-ref:
ray.is_initialized
~~~~~~~~~~~~~~~~~~
Add ray.is_initialized() function. (#2818) * Add ray.is_initialized() function. * Add assert.
2018-09-06 21:20:59 -07:00
.. autofunction:: ray.is_initialized
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-remote-ref:
ray.remote
~~~~~~~~~~
Move documentation to ReadTheDocs. (#326)
2017-02-27 21:14:31 -08:00
.. autofunction:: ray.remote
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-get-ref:
ray.get
~~~~~~~
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
.. autofunction:: ray.get
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-wait-ref:
ray.wait
~~~~~~~~
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.wait
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-put-ref:
ray.put
~~~~~~~
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
.. autofunction:: ray.put
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-kill-ref:
ray.kill
~~~~~~~~
Change actor.__ray_kill__() to ray.kill(actor) (#7360)
2020-02-28 11:55:14 -06:00
.. autofunction:: ray.kill
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-cancel-ref:
ray.cancel
~~~~~~~~~~
[Doc] Fix Docstring for Task Cancellation (#8198)
2020-04-27 17:06:08 -07:00
.. autofunction:: ray.cancel
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-get_gpu_ids-ref:
ray.get_gpu_ids
~~~~~~~~~~~~~~~
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.get_gpu_ids
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-get_resource_ids-ref:
ray.get_resource_ids
~~~~~~~~~~~~~~~~~~~~
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.get_resource_ids
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-get_webui_url-ref:
ray.get_webui_url
~~~~~~~~~~~~~~~~~
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.get_webui_url
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-shutdown-ref:
ray.shutdown
~~~~~~~~~~~~
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.shutdown
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-register_custom_serializer-ref:
ray.register_custom_serializer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.register_custom_serializer
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-profile-ref:
ray.profile
~~~~~~~~~~~
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.profile
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-method-ref:
ray.method
~~~~~~~~~~
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.method
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
ray.util.ActorPool
~~~~~~~~~~~~~~~~~~
.. autoclass:: ray.util.ActorPool
:members:
.. _ray-nodes-ref:
ray.nodes
~~~~~~~~~
Move global state API out of global_state object. (#4857)
2019-05-26 11:27:53 -07:00
[docs] rewrite (#5175)
2019-08-05 23:33:14 -07:00
.. autofunction:: ray.nodes
Move global state API out of global_state object. (#4857)
2019-05-26 11:27:53 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-objects-ref:
ray.objects
~~~~~~~~~~~
[docs] rewrite (#5175)
2019-08-05 23:33:14 -07:00
.. autofunction:: ray.objects
Move global state API out of global_state object. (#4857)
2019-05-26 11:27:53 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-timeline-ref:
ray.timeline
~~~~~~~~~~~~
[docs] rewrite (#5175)
2019-08-05 23:33:14 -07:00
.. autofunction:: ray.timeline
Move global state API out of global_state object. (#4857)
2019-05-26 11:27:53 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-object_transfer_timeline-ref:
ray.object_transfer_timeline
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[docs] rewrite (#5175)
2019-08-05 23:33:14 -07:00
.. autofunction:: ray.object_transfer_timeline
Move global state API out of global_state object. (#4857)
2019-05-26 11:27:53 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-cluster_resources-ref:
ray.cluster_resources
~~~~~~~~~~~~~~~~~~~~~
[docs] rewrite (#5175)
2019-08-05 23:33:14 -07:00
.. autofunction:: ray.cluster_resources
Move global state API out of global_state object. (#4857)
2019-05-26 11:27:53 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-available_resources-ref:
ray.available_resources
~~~~~~~~~~~~~~~~~~~~~~~
[docs] rewrite (#5175)
2019-08-05 23:33:14 -07:00
.. autofunction:: ray.available_resources
Move global state API out of global_state object. (#4857)
2019-05-26 11:27:53 -07:00
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _ray-errors-ref:
ray.errors
~~~~~~~~~~
[docs] rewrite (#5175)
2019-08-05 23:33:14 -07:00
.. autofunction:: ray.errors
Move global state API out of global_state object. (#4857)
2019-05-26 11:27:53 -07:00
[docs] Add documentation for Dynamic Custom Resources (#6000)
2019-10-27 17:58:04 -07:00
Experimental APIs
-----------------
.. automodule:: ray.experimental
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
:members:
Move global state API out of global_state object. (#4857)
2019-05-26 11:27:53 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
The Ray Command Line API
------------------------
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-start-doc:
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. click:: ray.scripts.scripts:start
:prog: ray start
:show-nested:
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-stop-doc:
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. click:: ray.scripts.scripts:stop
:prog: ray stop
:show-nested:
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-up-doc:
[docs] Show commands on documentation (#9165)
2020-06-27 12:56:56 -07:00
.. click:: ray.scripts.scripts:up
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
:prog: ray up
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
:show-nested:
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-down-doc:
[docs] Show commands on documentation (#9165)
2020-06-27 12:56:56 -07:00
.. click:: ray.scripts.scripts:down
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
:prog: ray down
:show-nested:
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-exec-doc:
[docs] Show commands on documentation (#9165)
2020-06-27 12:56:56 -07:00
.. click:: ray.scripts.scripts:exec
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
:prog: ray exec
:show-nested:
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-submit-doc:
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
.. click:: ray.scripts.scripts:submit
:prog: ray submit
:show-nested:
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-attach-doc:
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
.. click:: ray.scripts.scripts:attach
:prog: ray attach
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
:show-nested:
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-get_head_ip-doc:
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. click:: ray.scripts.scripts:get_head_ip
:prog: ray get_head_ip
:show-nested:
Add "ray timeline" command to auto-dump Chrome trace for the current Ray instance (#4239)
2019-03-05 16:28:00 -08:00
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-stack-doc:
Add "ray timeline" command to auto-dump Chrome trace for the current Ray instance (#4239)
2019-03-05 16:28:00 -08:00
.. click:: ray.scripts.scripts:stack
:prog: ray stack
:show-nested:
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-stat-doc:
[docs] Show commands on documentation (#9165)
2020-06-27 12:56:56 -07:00
.. click:: ray.scripts.scripts:statistics
:prog: ray statistics
Add 'ray stat' command for debugging (#6622) * wip * wip * wip * iterate * move * fix thread safety
2019-12-28 14:40:32 -08:00
:show-nested:
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-memory-doc:
First pass at `ray memory` command for memory debugging (#7589)
2020-03-17 20:45:07 -07:00
.. click:: ray.scripts.scripts:memory
:prog: ray memory
:show-nested:
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-globalgc-doc:
First pass at `ray memory` command for memory debugging (#7589)
2020-03-17 20:45:07 -07:00
.. click:: ray.scripts.scripts:globalgc
:prog: ray globalgc
:show-nested:
[docs] Revised Cluster documentation (#9062) Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
.. _ray-timeline-doc:
Add "ray timeline" command to auto-dump Chrome trace for the current Ray instance (#4239)
2019-03-05 16:28:00 -08:00
.. click:: ray.scripts.scripts:timeline
:prog: ray timeline
:show-nested:
Reference in a new issue Copy permalink