chore: import upstream snapshot with attribution
This commit is contained in:
wehub-resource-sync
@@ -0,0 +1,53 @@
|
||||
Ray Core CLI
|
||||
============
|
||||
|
||||
.. _ray-cli:
|
||||
|
||||
Debugging applications
|
||||
----------------------
|
||||
This section contains commands for inspecting and debugging the current cluster.
|
||||
|
||||
.. _ray-stack-doc:
|
||||
|
||||
.. click:: ray.scripts.scripts:stack
|
||||
:prog: ray stack
|
||||
:show-nested:
|
||||
|
||||
.. _ray-memory-doc:
|
||||
|
||||
.. click:: ray.scripts.scripts:memory
|
||||
:prog: ray memory
|
||||
:show-nested:
|
||||
|
||||
.. _ray-timeline-doc:
|
||||
|
||||
.. click:: ray.scripts.scripts:timeline
|
||||
:prog: ray timeline
|
||||
:show-nested:
|
||||
|
||||
.. _ray-status-doc:
|
||||
|
||||
.. click:: ray.scripts.scripts:status
|
||||
:prog: ray status
|
||||
:show-nested:
|
||||
|
||||
.. click:: ray.scripts.scripts:debug
|
||||
:prog: ray debug
|
||||
:show-nested:
|
||||
|
||||
|
||||
Usage Stats
|
||||
-----------
|
||||
This section contains commands to enable/disable :ref:`Ray usage stats <ref-usage-stats>`.
|
||||
|
||||
.. _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:
|
||||
@@ -0,0 +1,75 @@
|
||||
Core API
|
||||
========
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.init
|
||||
ray.shutdown
|
||||
ray.is_initialized
|
||||
ray.job_config.JobConfig
|
||||
ray.LoggingConfig
|
||||
|
||||
Tasks
|
||||
-----
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.remote
|
||||
ray.remote_function.RemoteFunction.options
|
||||
ray.cancel
|
||||
|
||||
Actors
|
||||
------
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.remote
|
||||
ray.actor.ActorClass
|
||||
ray.actor.ActorClass.options
|
||||
ray.actor.ActorMethod
|
||||
ray.actor.ActorHandle
|
||||
ray.actor.ActorClassInheritanceException
|
||||
ray.actor.exit_actor
|
||||
ray.method
|
||||
ray.get_actor
|
||||
ray.kill
|
||||
|
||||
Objects
|
||||
-------
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.get
|
||||
ray.wait
|
||||
ray.put
|
||||
ray.util.as_completed
|
||||
ray.util.map_unordered
|
||||
|
||||
.. _runtime-context-apis:
|
||||
|
||||
Runtime Context
|
||||
---------------
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.runtime_context.get_runtime_context
|
||||
ray.runtime_context.RuntimeContext
|
||||
ray.get_gpu_ids
|
||||
|
||||
Cross Language
|
||||
--------------
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.cross_language.java_function
|
||||
ray.cross_language.java_actor_class
|
||||
@@ -0,0 +1,43 @@
|
||||
Ray Direct Transport (RDT) API
|
||||
==============================
|
||||
|
||||
Usage with Core APIs
|
||||
--------------------
|
||||
Enable RDT for actor tasks with the :func:`@ray.method <ray.method>` decorator, or pass `_tensor_transport` to :func:`ray.put`. You can then pass the resulting `ray.ObjectRef` to other actor tasks, or use :func:`ray.get` to retrieve the result. See :ref:`Ray Direct Transport (RDT) <direct-transport>` for more details on usage.
|
||||
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.method
|
||||
ray.put
|
||||
ray.get
|
||||
|
||||
Collective tensor transports
|
||||
----------------------------
|
||||
Collective tensor transports require a collective group to be created before RDT objects can be used. Use these methods to create and manage collective groups for the `gloo` and `nccl` tensor transports.
|
||||
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.experimental.collective.create_collective_group
|
||||
ray.experimental.collective.get_collective_groups
|
||||
ray.experimental.collective.destroy_collective_group
|
||||
|
||||
Advanced APIs
|
||||
-------------
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.experimental.register_nixl_memory
|
||||
ray.experimental.deregister_nixl_memory
|
||||
ray.experimental.register_nixl_memory_pool
|
||||
ray.experimental.set_target_for_ref
|
||||
ray.experimental.wait_tensor_freed
|
||||
ray.experimental.register_tensor_transport
|
||||
ray.experimental.TensorTransportManager
|
||||
@@ -0,0 +1,42 @@
|
||||
.. _ray-core-exceptions:
|
||||
|
||||
Exceptions
|
||||
==========
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.exceptions.RayError
|
||||
ray.exceptions.RayTaskError
|
||||
ray.exceptions.RayActorError
|
||||
ray.exceptions.TaskCancelledError
|
||||
ray.exceptions.TaskUnschedulableError
|
||||
ray.exceptions.ActorDiedError
|
||||
ray.exceptions.ActorUnschedulableError
|
||||
ray.exceptions.ActorUnavailableError
|
||||
ray.exceptions.AsyncioActorExit
|
||||
ray.exceptions.LocalRayletDiedError
|
||||
ray.exceptions.WorkerCrashedError
|
||||
ray.exceptions.TaskPlacementGroupRemoved
|
||||
ray.exceptions.ActorPlacementGroupRemoved
|
||||
ray.exceptions.ObjectStoreFullError
|
||||
ray.exceptions.OutOfDiskError
|
||||
ray.exceptions.OutOfMemoryError
|
||||
ray.exceptions.ObjectLostError
|
||||
ray.exceptions.ObjectFetchTimedOutError
|
||||
ray.exceptions.GetTimeoutError
|
||||
ray.exceptions.OwnerDiedError
|
||||
ray.exceptions.PendingCallsLimitExceeded
|
||||
ray.exceptions.PlasmaObjectNotAvailable
|
||||
ray.exceptions.ObjectReconstructionFailedError
|
||||
ray.exceptions.RayChannelError
|
||||
ray.exceptions.RayChannelTimeoutError
|
||||
ray.exceptions.RayCgraphCapacityExceeded
|
||||
ray.exceptions.RayDirectTransportError
|
||||
ray.exceptions.RuntimeEnvSetupError
|
||||
ray.exceptions.CrossLanguageError
|
||||
ray.exceptions.RaySystemError
|
||||
ray.exceptions.NodeDiedError
|
||||
ray.exceptions.UnserializableException
|
||||
ray.exceptions.AuthenticationError
|
||||
@@ -0,0 +1,15 @@
|
||||
Ray Core API
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
core.rst
|
||||
scheduling.rst
|
||||
runtime-env.rst
|
||||
utility.rst
|
||||
exceptions.rst
|
||||
cli.rst
|
||||
../../ray-observability/reference/cli.rst
|
||||
../../ray-observability/reference/api.rst
|
||||
direct-transport.rst
|
||||
@@ -0,0 +1,9 @@
|
||||
Runtime Env API
|
||||
===============
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.runtime_env.RuntimeEnvConfig
|
||||
ray.runtime_env.RuntimeEnv
|
||||
@@ -0,0 +1,28 @@
|
||||
Scheduling API
|
||||
==============
|
||||
|
||||
Scheduling Strategy
|
||||
-------------------
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.util.scheduling_strategies.PlacementGroupSchedulingStrategy
|
||||
ray.util.scheduling_strategies.NodeAffinitySchedulingStrategy
|
||||
|
||||
.. _ray-placement-group-ref:
|
||||
|
||||
Placement Group
|
||||
---------------
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.util.placement_group
|
||||
ray.util.placement_group.get_placement_group
|
||||
ray.util.placement_group.PlacementGroup
|
||||
ray.util.placement_group_table
|
||||
ray.util.remove_placement_group
|
||||
ray.util.get_current_placement_group
|
||||
@@ -0,0 +1,62 @@
|
||||
Utility
|
||||
=======
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.util.ActorPool
|
||||
ray.util.queue.Queue
|
||||
ray.util.list_named_actors
|
||||
|
||||
ray.util.serialization.register_serializer
|
||||
ray.util.serialization.deregister_serializer
|
||||
|
||||
ray.util.tpu.get_current_pod_worker_count
|
||||
ray.util.tpu.get_current_pod_name
|
||||
ray.util.tpu.get_num_tpu_chips_on_node
|
||||
ray.util.tpu.get_tpu_coordinator_env_vars
|
||||
ray.util.tpu.get_tpu_slice_name_from_node
|
||||
ray.util.tpu.get_tpu_nodes_for_slice
|
||||
ray.util.tpu.get_num_ready_tpu_slices
|
||||
ray.util.tpu.get_tpu_num_slices_for_workers
|
||||
ray.util.tpu.get_tpu_version_from_type
|
||||
ray.util.tpu.get_tpu_worker_resources
|
||||
ray.util.tpu.init_jax_profiler
|
||||
|
||||
ray.util.tpu.SlicePlacementGroup
|
||||
ray.util.tpu.slice_placement_group
|
||||
|
||||
ray.nodes
|
||||
ray.cluster_resources
|
||||
ray.available_resources
|
||||
|
||||
.. Other docs have references to these
|
||||
ray.util.queue.Empty
|
||||
ray.util.queue.Full
|
||||
|
||||
.. _custom-metric-api-ref:
|
||||
|
||||
Custom Metrics
|
||||
--------------
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.util.metrics.Counter
|
||||
ray.util.metrics.Gauge
|
||||
ray.util.metrics.Histogram
|
||||
|
||||
.. _package-ref-debugging-apis:
|
||||
|
||||
Debugging
|
||||
---------
|
||||
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
:toctree: doc/
|
||||
|
||||
ray.util.rpdb.set_trace
|
||||
ray.util.inspect_serializability
|
||||
ray.timeline
|
||||
Reference in New Issue
Block a user