Ray Jobs CLI API 参考#

本节包含用于 Ray 作业提交的命令。

ray job submit#

将作业提交到集群运行。

默认情况下（如果未设置 --no-wait），会将日志流式传输到 stdout 直至作业完成。如果作业成功，则以 0 退出。如果作业失败，则以 1 退出。

示例: ray job submit -- python my_script.py --arg=val

ray job submit [OPTIONS] ENTRYPOINT...

选项

--address <address>#: 要连接的 Ray 集群的地址。也可以通过 RAY_API_SERVER_ADDRESS 环境变量指定（回退到 RAY_ADDRESS）。

--job-id <job_id>#: 已弃用：请改用 --submission-id。

--submission-id <submission_id>#: 要为作业指定的提交 ID。如果未提供，则会生成一个。

--runtime-env <runtime_env>#: 包含 runtime_env 定义的本地 YAML 文件的路径。

--runtime-env-json <runtime_env_json>#: JSON 序列化的 runtime_env 字典。

--working-dir <working_dir>#: 包含作业将要运行的文件的目录。可以是本地目录，也可以是 .zip 文件的远程 URI（S3、GS、HTTP）。如果指定，此选项将覆盖 --runtime-env 中的选项。

--metadata-json <metadata_json>#: 要附加到作业的 JSON 序列化的元数据字典。

--entrypoint-num-cpus <entrypoint_num_cpus>#: 为入口点命令保留的 CPU 核心数量，与它启动的任何任务或 actor 分开。

--entrypoint-num-gpus <entrypoint_num_gpus>#: 为入口点命令保留的 GPU 数量，与它启动的任何任务或 actor 分开。

--entrypoint-memory <entrypoint_memory>#: 为入口点命令保留的内存量，与它启动的任何任务或 actor 分开。

--entrypoint-resources <entrypoint_resources>#: 一个 JSON 序列化的字典，将资源名称映射到资源数量，描述为入口点命令保留的资源，与它启动的任何任务或 actor 分开。

--no-wait#: 如果设置，则不会流式传输日志并等待作业退出。

--verify <verify>#

布尔值，指示是否验证服务器的 TLS 证书，或指向受信任证书的文件或目录的路径。

默认值:: True

--headers <headers>#: 用于通过 http/s 将标头传递到 Ray 集群。请遵循 JSON 格式 {“key”: “value”}

--log-style <log_style>#

如果为 'pretty'，则以格式化和彩色输出。如果为 'record'，则以记录式输出，无格式化。 'auto' 默认为 'pretty'，并且如果 stdin *不是* TTY，则禁用 pretty 日志记录。

选项:: auto | record | pretty

--log-color <log_color>#

使用彩色日志记录。如果 stdout 是 TTY，则 Auto 会启用彩色日志记录。

选项:: auto | false | true

-v, --verbose#

参数

ENTRYPOINT#: 必需参数

警告

使用 CLI 时，请勿将入口点命令包含在引号中。例如，使用 ray job submit --working-dir="." -- python script.py 而不是 ray job submit --working-dir="." -- "python script.py"。否则，您可能会遇到错误 /bin/sh: 1: python script.py: not found。

警告

您必须将入口点命令（python script.py）放在最后（在 -- 之后），并且 ray job submit 的任何其他参数（例如 --working-dir="."）必须在两个连字符（--）之前提供。例如，使用 ray job submit --working-dir="." -- python script.py 而不是 ray job submit -- python script.py --working-dir="."。此语法支持使用 -- 将 ray job submit 的参数与入口点命令的参数分开。

ray job status#

查询作业的当前状态。

示例: ray job status <my_job_id>

ray job status [OPTIONS] JOB_ID

选项

--address <address>#: 要连接的 Ray 集群的地址。也可以通过 RAY_API_SERVER_ADDRESS 环境变量指定（回退到 RAY_ADDRESS）。

--verify <verify>#

布尔值，指示是否验证服务器的 TLS 证书，或指向受信任证书的文件或目录的路径。

默认值:: True

--headers <headers>#: 用于通过 http/s 将标头传递到 Ray 集群。请遵循 JSON 格式 {“key”: “value”}

--log-style <log_style>#

选项:: auto | record | pretty

--log-color <log_color>#

使用彩色日志记录。如果 stdout 是 TTY，则 Auto 会启用彩色日志记录。

选项:: auto | false | true

-v, --verbose#

参数

JOB_ID#: 必需参数。

ray job stop#

尝试停止一个作业。

示例: ray job stop <my_job_id>

ray job stop [OPTIONS] JOB_ID

选项

--address <address>#: 要连接的 Ray 集群的地址。也可以通过 RAY_API_SERVER_ADDRESS 环境变量指定（回退到 RAY_ADDRESS）。

--no-wait#: 如果设置，则不会等待作业退出。

--verify <verify>#

布尔值，指示是否验证服务器的 TLS 证书，或指向受信任证书的文件或目录的路径。

默认值:: True

--headers <headers>#: 用于通过 http/s 将标头传递到 Ray 集群。请遵循 JSON 格式 {“key”: “value”}

--log-style <log_style>#

选项:: auto | record | pretty

--log-color <log_color>#

使用彩色日志记录。如果 stdout 是 TTY，则 Auto 会启用彩色日志记录。

选项:: auto | false | true

-v, --verbose#

参数

JOB_ID#: 必需参数。

ray job logs#

获取作业的日志。

示例: ray job logs <my_job_id>

ray job logs [OPTIONS] JOB_ID

选项

--address <address>#: 要连接的 Ray 集群的地址。也可以通过 RAY_API_SERVER_ADDRESS 环境变量指定（回退到 RAY_ADDRESS）。

-f, --follow#: 如果设置，则关注日志（类似于 tail -f）。

--verify <verify>#

布尔值，指示是否验证服务器的 TLS 证书，或指向受信任证书的文件或目录的路径。

默认值:: True

--headers <headers>#: 用于通过 http/s 将标头传递到 Ray 集群。请遵循 JSON 格式 {“key”: “value”}

--log-style <log_style>#

选项:: auto | record | pretty

--log-color <log_color>#

使用彩色日志记录。如果 stdout 是 TTY，则 Auto 会启用彩色日志记录。

选项:: auto | false | true

-v, --verbose#

参数

JOB_ID#: 必需参数。

ray job list#

列出所有正在运行的作业及其信息。

示例: ray job list

ray job list [OPTIONS]

选项

--address <address>#: 要连接的 Ray 集群的地址。也可以通过 RAY_API_SERVER_ADDRESS 环境变量指定（回退到 RAY_ADDRESS）。

--verify <verify>#

布尔值，指示是否验证服务器的 TLS 证书，或指向受信任证书的文件或目录的路径。

默认值:: True

--headers <headers>#: 用于通过 http/s 将标头传递到 Ray 集群。请遵循 JSON 格式 {“key”: “value”}

--log-style <log_style>#

选项:: auto | record | pretty

--log-color <log_color>#

使用彩色日志记录。如果 stdout 是 TTY，则 Auto 会启用彩色日志记录。

选项:: auto | false | true

-v, --verbose#

ray job delete#

删除已停止的作业及其在内存中的关联数据。

仅支持已处于终止状态的作业。如果作业尚未停止，则以退出代码 1 失败。不会从磁盘删除作业日志。不支持提交具有与先前删除作业相同的提交 ID 的作业，这可能会导致意外行为。

示例: ray job delete <my_job_id>

ray job delete [OPTIONS] JOB_ID

选项

--address <address>#: 要连接的 Ray 集群的地址。也可以通过 RAY_API_SERVER_ADDRESS 环境变量指定（回退到 RAY_ADDRESS）。

--verify <verify>#

布尔值，指示是否验证服务器的 TLS 证书，或指向受信任证书的文件或目录的路径。

默认值:: True

--headers <headers>#: 用于通过 http/s 将标头传递到 Ray 集群。请遵循 JSON 格式 {“key”: “value”}

--log-style <log_style>#

选项:: auto | record | pretty

--log-color <log_color>#

使用彩色日志记录。如果 stdout 是 TTY，则 Auto 会启用彩色日志记录。

选项:: auto | false | true

-v, --verbose#

参数

JOB_ID#: 必需参数。