hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-06 18:41:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ray/doc/source/ray-core/package-ref.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

335 lines
5 KiB
ReStructuredText
Raw Normal View History

[docs] landing page (fixes #21750) (#21859) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2022-01-27 02:14:25 +01:00
Ray Core API
============
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
[Doc] Document options method (#10830) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-09-16 14:23:24 -07:00
.. autofunction:: ray.remote_function.RemoteFunction.options
.. autofunction:: ray.actor.ActorClass.options
[Placement group] Update the old placement group API usage to the new scheduling_strategy based API (#24544) Documentation should use the new API, not the old one that will be deprecated
2022-05-19 01:41:51 +09:00
.. _scheduling-strategy-ref:
.. autofunction:: ray.util.scheduling_strategies.PlacementGroupSchedulingStrategy
.. autofunction:: ray.util.scheduling_strategies.NodeAffinitySchedulingStrategy
[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] Add `get_actor` as top level API (#15484)
2021-05-04 12:25:53 -07:00
.. _ray-get_actor-ref:
ray.get_actor
~~~~~~~~~~~~~~~
.. autofunction:: ray.get_actor
[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-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-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:
Promote ray.experimental.queue to ray.util (#10624)
2020-09-08 12:56:53 -07:00
ray.util.queue.Queue
~~~~~~~~~~~~~~~~~~~~
.. _ray-queue-ref:
.. autoclass:: ray.util.queue.Queue
:members:
[docs] Render ActorPool documentation, etc (#9433)
2020-07-13 17:59:22 -07:00
.. _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-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-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
[Doc] Cross language page (#10471)
2020-09-08 16:51:40 +08:00
ray.cross_language
[docs] Placement group documentation (#10555) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-09-16 16:07:55 -07:00
~~~~~~~~~~~~~~~~~~
[Doc] Cross language page (#10471)
2020-09-08 16:51:40 +08:00
[C++ Worker]Python call cpp worker (#22820)
2022-03-11 03:06:14 +08:00
.. autofunction:: ray.cross_language.java_function
[Doc] Cross language page (#10471)
2020-09-08 16:51:40 +08:00
[C++ Worker]Python call cpp worker (#22820)
2022-03-11 03:06:14 +08:00
.. autofunction:: ray.cross_language.java_actor_class
[Doc] Cross language page (#10471)
2020-09-08 16:51:40 +08:00
[docs] Placement group documentation (#10555) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-09-16 16:07:55 -07:00
.. _ray-placement-group-ref:
Placement Group APIs
--------------------
placement_group
~~~~~~~~~~~~~~~
.. autofunction:: ray.util.placement_group.placement_group
PlacementGroup (class)
~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: ray.util.placement_group.PlacementGroup
:members:
placement_group_table
~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: ray.util.placement_group.placement_group_table
remove_placement_group
~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: ray.util.placement_group.remove_placement_group
[Placement Group] Capture Child Task Part 1 (#10968) * In progress. * In progers. * Done. * Addressed code review. * Increase timeout to make a test less flaky. * Addressed code review. * Addressed code review.
2020-09-24 09:02:03 -07:00
get_current_placement_group
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: ray.util.placement_group.get_current_placement_group
[Metric] custom metrics refinement (#10861) * In progress * In Progress. * Addressed code review. * Add unit tests. * Add a simple doc. * Fixed test failure. * Fix all test failures from serve. * Addressed code review.
2020-09-25 09:10:28 -07:00
.. _custom-metric-api-ref:
Custom Metrics APIs
-------------------
[metrics] Cleanup package ref (#14658)
2021-03-15 13:00:57 -05:00
Counter
~~~~~~~
[Metric] custom metrics refinement (#10861) * In progress * In Progress. * Addressed code review. * Add unit tests. * Add a simple doc. * Fixed test failure. * Fix all test failures from serve. * Addressed code review.
2020-09-25 09:10:28 -07:00
[metrics] Cleanup package ref (#14658)
2021-03-15 13:00:57 -05:00
.. autoclass:: ray.util.metrics.Counter
[Metric] custom metrics refinement (#10861) * In progress * In Progress. * Addressed code review. * Add unit tests. * Add a simple doc. * Fixed test failure. * Fix all test failures from serve. * Addressed code review.
2020-09-25 09:10:28 -07:00
:members:
Gauge
~~~~~
.. autoclass:: ray.util.metrics.Gauge
:members:
Histogram
~~~~~~~~~
.. autoclass:: ray.util.metrics.Histogram
:members:
[Doc] Ray logging document. (#14102) * Initial draft done. * Addressed code review.
2021-02-16 15:27:30 -08:00
.. _runtime-context-apis:
Runtime Context APIs
--------------------
.. autofunction:: ray.runtime_context.get_runtime_context
.. autoclass:: ray.runtime_context.RuntimeContext
:members:
[runtime env][strong-typed API] Combine `ParsedRuntimeEnv` and `RuntimeEnv` into `ray.runtime.RuntimeEnv` (#22522) Combine `ParsedRuntimeEnv` and `RuntimeEnv` into `ray.runtime.RuntimeEnv`, details: #21495 - The `new RuntimeEnv` includes all external interfaces of `ParsedRuntimeEnv` and `old RuntimeEnv`. - The `new RuntimeEnv` will be exposed directly to the user. - example: ```python runtime_env = ray.runtime_env.RuntimeEnv(working_dir="s3://workding_dir.zip", pip=["requests"], java_jars=["s3://jar1.zip"], java_jvm_options=["-Dxxx=xxx"]) ```
2022-02-28 16:18:10 +08:00
.. _runtime-env-apis:
Runtime Env APIs
[runtime env] Support set timeout for runtime env setup (#23082) Interface example: ```python @ray.remote(runtime_env=RuntimeEnv(..., config=RuntimeEnvConfig(setup_timeout_s=10)) def f(): pass @ray.remote(runtime_env={..., "config": {"setup_timeout_s": 10}}) def f(): pass ``` Support set timeout second for timeout of runtime environment creation. Co-authored-by: 捕牛 <hejialing.hjl@antgroup.com>
2022-03-19 01:52:59 +08:00
----------------
.. autoclass:: ray.runtime_env.RuntimeEnvConfig
:members:
[runtime env][strong-typed API] Combine `ParsedRuntimeEnv` and `RuntimeEnv` into `ray.runtime.RuntimeEnv` (#22522) Combine `ParsedRuntimeEnv` and `RuntimeEnv` into `ray.runtime.RuntimeEnv`, details: #21495 - The `new RuntimeEnv` includes all external interfaces of `ParsedRuntimeEnv` and `old RuntimeEnv`. - The `new RuntimeEnv` will be exposed directly to the user. - example: ```python runtime_env = ray.runtime_env.RuntimeEnv(working_dir="s3://workding_dir.zip", pip=["requests"], java_jars=["s3://jar1.zip"], java_jvm_options=["-Dxxx=xxx"]) ```
2022-02-28 16:18:10 +08:00
.. autoclass:: ray.runtime_env.RuntimeEnv
:members:
[runtime env] Support set timeout for runtime env setup (#23082) Interface example: ```python @ray.remote(runtime_env=RuntimeEnv(..., config=RuntimeEnvConfig(setup_timeout_s=10)) def f(): pass @ray.remote(runtime_env={..., "config": {"setup_timeout_s": 10}}) def f(): pass ``` Support set timeout second for timeout of runtime environment creation. Co-authored-by: 捕牛 <hejialing.hjl@antgroup.com>
2022-03-19 01:52:59 +08:00
[doc] Add documentation for Ray debugger (#11815) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-05 16:25:27 -08:00
.. _package-ref-debugging-apis:
[tune/core] serialization debugging utility (#12142) Co-authored-by: SangBin Cho <rkooo567@gmail.com> Co-authored-by: Kai Fricke <kai@anyscale.com>
2020-12-02 00:52:17 -08:00
Debugging APIs
--------------
[doc] Add documentation for Ray debugger (#11815) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-05 16:25:27 -08:00
.. autofunction:: ray.util.pdb.set_trace
[tune/core] serialization debugging utility (#12142) Co-authored-by: SangBin Cho <rkooo567@gmail.com> Co-authored-by: Kai Fricke <kai@anyscale.com>
2020-12-02 00:52:17 -08:00
.. autofunction:: ray.util.inspect_serializability
[autoscaler][kubernetes][docs] Updated Kubernetes Documentation (#14016) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2021-02-11 23:00:25 -08:00
.. _ray-cli:
[Doc] Add a section for synchronization primitives in Ray (#10581) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-09-04 17:09:15 -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-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-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:
[runtime env] Support set timeout for runtime env setup (#23082) Interface example: ```python @ray.remote(runtime_env=RuntimeEnv(..., config=RuntimeEnvConfig(setup_timeout_s=10)) def f(): pass @ray.remote(runtime_env={..., "config": {"setup_timeout_s": 10}}) def f(): pass ``` Support set timeout second for timeout of runtime environment creation. Co-authored-by: 捕牛 <hejialing.hjl@antgroup.com>
2022-03-19 01:52:59 +08:00
[docs] include ray status and ray monitor into ray command line api docs (#22614) Fixes: https://github.com/ray-project/ray/issues/18527
2022-02-23 23:09:45 -05:00
.. _ray-status-doc:
.. click:: ray.scripts.scripts:status
:prog: ray status
:show-nested:
[runtime env] Support set timeout for runtime env setup (#23082) Interface example: ```python @ray.remote(runtime_env=RuntimeEnv(..., config=RuntimeEnvConfig(setup_timeout_s=10)) def f(): pass @ray.remote(runtime_env={..., "config": {"setup_timeout_s": 10}}) def f(): pass ``` Support set timeout second for timeout of runtime environment creation. Co-authored-by: 捕牛 <hejialing.hjl@antgroup.com>
2022-03-19 01:52:59 +08:00
[docs] include ray status and ray monitor into ray command line api docs (#22614) Fixes: https://github.com/ray-project/ray/issues/18527
2022-02-23 23:09:45 -05:00
.. _ray-monitor-doc:
.. click:: ray.scripts.scripts:monitor
:prog: ray monitor
:show-nested:
[doc] Add documentation for Ray debugger (#11815) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-05 16:25:27 -08:00
.. click:: ray.scripts.scripts:debug
:prog: ray debug
:show-nested:
[Doc] Add doc for usage stats collection (#24522)
2022-05-10 17:18:49 -07:00
.. _ray-disable-usage-stats-doc:
.. click:: ray.scripts.scripts:disable_usage_stats
:prog: ray disable-usage-stats
:show-nested:
.. _ray-enable-usage-stats-doc:
.. click:: ray.scripts.scripts:enable_usage_stats
:prog: ray enable-usage-stats
:show-nested:
Reference in a new issue Copy permalink