Ray Jobs CLI API 参考#

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

ray job submit#

提交一个任务到集群上运行。

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

示例：

ray job submit -- python my_script.py --arg=val

ray job submit [OPTIONS] ENTRYPOINT...

选项

--address <address>#

要连接的 Ray 集群的地址。也可以使用 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 核心数量，与由此启动的任何任务或角色分开

--entrypoint-num-gpus <entrypoint_num_gpus>#

为入口点命令预留的GPU数量，与由其启动的任何任务或角色分开

--entrypoint-memory <entrypoint_memory>#

为入口点命令预留的内存量，与由其启动的任何任务或角色分开

--entrypoint-resources <entrypoint_resources>#

一个JSON序列化的字典，将资源名称映射到资源数量，描述为入口点命令预留的资源，与由其启动的任何任务或角色分开。

--no-wait#

如果设置，将不会流式传输日志，而是等待作业退出。

--verify <verify>#

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

默认:

True

--headers <headers>#

用于将HTTP/S头传递到Ray集群。请遵循JSON格式化格式 {“key”: “value”}

--log-style <log_style>#

如果为 ‘pretty’，则输出带有格式和颜色。如果为 ‘record’，则输出记录样式而不带格式。’auto’ 默认值为 ‘pretty’，如果标准输入 不是 TTY，则禁用漂亮的日志记录。

选项:

自动 | 记录 | 漂亮

--log-color <log_color>#

使用彩色日志记录。如果标准输出是TTY，则自动启用彩色日志记录。

选项:

自动 | 否 | 是

-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_ADDRESS 环境变量来指定。

--verify <verify>#

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

默认:

True

--headers <headers>#

用于将HTTP/S头传递到Ray集群。请遵循JSON格式化格式 {“key”: “value”}

--log-style <log_style>#

如果为 ‘pretty’，则输出带有格式和颜色。如果为 ‘record’，则输出记录样式而不带格式。’auto’ 默认值为 ‘pretty’，如果标准输入 不是 TTY，则禁用漂亮的日志记录。

选项:

自动 | 记录 | 漂亮

--log-color <log_color>#

使用彩色日志记录。如果标准输出是TTY，则自动启用彩色日志记录。

选项:

自动 | 否 | 是

-v, --verbose#

参数

JOB_ID#

必需参数

ray job stop#

尝试停止一个作业。

示例：

ray job stop <my_job_id>

ray job stop [OPTIONS] JOB_ID

选项

--address <address>#

要连接的 Ray 集群的地址。也可以使用 RAY_ADDRESS 环境变量来指定。

--no-wait#

如果设置，将不会等待作业退出。

--verify <verify>#

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

默认:

True

--headers <headers>#

用于将HTTP/S头传递到Ray集群。请遵循JSON格式化格式 {“key”: “value”}

--log-style <log_style>#

如果为 ‘pretty’，则输出带有格式和颜色。如果为 ‘record’，则输出记录样式而不带格式。’auto’ 默认值为 ‘pretty’，如果标准输入 不是 TTY，则禁用漂亮的日志记录。

选项:

自动 | 记录 | 漂亮

--log-color <log_color>#

使用彩色日志记录。如果标准输出是TTY，则自动启用彩色日志记录。

选项:

自动 | 否 | 是

-v, --verbose#

参数

JOB_ID#

必需参数

ray job logs#

获取作业的日志。

示例：

ray job logs <my_job_id>

ray job logs [OPTIONS] JOB_ID

选项

--address <address>#

要连接的 Ray 集群的地址。也可以使用 RAY_ADDRESS 环境变量来指定。

-f, --follow#

如果设置，则跟随日志（类似于 tail -f）。

--verify <verify>#

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

默认:

True

--headers <headers>#

用于将HTTP/S头传递到Ray集群。请遵循JSON格式化格式 {“key”: “value”}

--log-style <log_style>#

如果为 ‘pretty’，则输出带有格式和颜色。如果为 ‘record’，则输出记录样式而不带格式。’auto’ 默认值为 ‘pretty’，如果标准输入 不是 TTY，则禁用漂亮的日志记录。

选项:

自动 | 记录 | 漂亮

--log-color <log_color>#

使用彩色日志记录。如果标准输出是TTY，则自动启用彩色日志记录。

选项:

自动 | 否 | 是

-v, --verbose#

参数

JOB_ID#

必需参数

ray job list#

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

示例：

ray job list

ray job list [OPTIONS]

选项

--address <address>#

要连接的 Ray 集群的地址。也可以使用 RAY_ADDRESS 环境变量来指定。

--verify <verify>#

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

默认:

True

--headers <headers>#

用于将HTTP/S头传递到Ray集群。请遵循JSON格式化格式 {“key”: “value”}

--log-style <log_style>#

如果为 ‘pretty’，则输出带有格式和颜色。如果为 ‘record’，则输出记录样式而不带格式。’auto’ 默认值为 ‘pretty’，如果标准输入 不是 TTY，则禁用漂亮的日志记录。

选项:

自动 | 记录 | 漂亮

--log-color <log_color>#

使用彩色日志记录。如果标准输出是TTY，则自动启用彩色日志记录。

选项:

自动 | 否 | 是

-v, --verbose#

ray job delete#

从内存中删除一个已停止的任务及其相关数据。

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

示例：

ray job delete <my_job_id>

ray job delete [OPTIONS] JOB_ID

选项

--address <address>#

要连接的 Ray 集群的地址。也可以使用 RAY_ADDRESS 环境变量来指定。

--verify <verify>#

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

默认:

True

--headers <headers>#

用于将HTTP/S头传递到Ray集群。请遵循JSON格式化格式 {“key”: “value”}

--log-style <log_style>#

如果为 ‘pretty’，则输出带有格式和颜色。如果为 ‘record’，则输出记录样式而不带格式。’auto’ 默认值为 ‘pretty’，如果标准输入 不是 TTY，则禁用漂亮的日志记录。

选项:

自动 | 记录 | 漂亮

--log-color <log_color>#

使用彩色日志记录。如果标准输出是TTY，则自动启用彩色日志记录。

选项:

自动 | 否 | 是

-v, --verbose#

参数

JOB_ID#

必需参数