Sandbox API

Note

Ray Sandboxes (ray.experimental.sandbox) is an alpha library. The API can change before it graduates to stable.

For an introduction and usage guides, see Ray Sandboxes.

Sandbox lifecycle and execution

ray.experimental.sandbox.create	Create a remote sandbox environment managed by a Ray actor.
ray.experimental.sandbox.Sandbox
ray.experimental.sandbox.SandboxRuntime	Low-level interface for managing local sandbox runtime environments.

Data structures and status

ray.experimental.sandbox.ExecResult	Result of executing a command inside a Sandbox.
ray.experimental.sandbox.SandboxStatus	Operational status of a Sandbox.

Exceptions

ray.experimental.sandbox.SandboxError	Base exception for all Ray Sandbox errors.
ray.experimental.sandbox.SandboxCreationError	Raised when sandbox creation fails or times out.
ray.experimental.sandbox.SandboxTimeoutError	Raised when a command execution or operation inside a sandbox times out.
ray.experimental.sandbox.SandboxExecError	Raised when a command execution encounters an unexpected system/backend error.
ray.experimental.sandbox.SandboxNotFoundError	Raised when a specified sandbox ID cannot be found.