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_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'，如果标准输入不是 TTY，则禁用漂亮日志记录。
- 选项:
auto | record | pretty
- --log-color <log_color>#
使用彩色日志记录。如果标准输出是 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_ADDRESS环境变量指定。
- --verify <verify>#
一个布尔值指示，用于验证服务器的 TLS 证书，或者指定一个包含受信任证书的文件或目录路径。
- 默认值:
True
- --headers <headers>#
用于通过 http/s 将头部信息传递给 Ray 集群。请遵循 JSON 格式：{“key”: “value”}
- --log-style <log_style>#
如果设置为 'pretty'，输出带有格式和颜色。如果设置为 'record'，输出记录风格，没有格式。'auto' 默认使用 'pretty'，如果标准输入不是 TTY，则禁用漂亮日志记录。
- 选项:
auto | record | pretty
- --log-color <log_color>#
使用彩色日志记录。如果标准输出是 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_ADDRESS环境变量指定。
- --no-wait#
如果设置，将不等待作业退出。
- --verify <verify>#
一个布尔值指示，用于验证服务器的 TLS 证书，或者指定一个包含受信任证书的文件或目录路径。
- 默认值:
True
- --headers <headers>#
用于通过 http/s 将头部信息传递给 Ray 集群。请遵循 JSON 格式：{“key”: “value”}
- --log-style <log_style>#
如果设置为 'pretty'，输出带有格式和颜色。如果设置为 'record'，输出记录风格，没有格式。'auto' 默认使用 'pretty'，如果标准输入不是 TTY，则禁用漂亮日志记录。
- 选项:
auto | record | pretty
- --log-color <log_color>#
使用彩色日志记录。如果标准输出是 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_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，则禁用漂亮日志记录。
- 选项:
auto | record | pretty
- --log-color <log_color>#
使用彩色日志记录。如果标准输出是 TTY，Auto 会启用彩色日志记录。
- 选项:
auto | false | true
- -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，则禁用漂亮日志记录。
- 选项:
auto | record | pretty
- --log-color <log_color>#
使用彩色日志记录。如果标准输出是 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_ADDRESS 环境变量指定。
- --verify <verify>#
一个布尔值指示，用于验证服务器的 TLS 证书，或者指定一个包含受信任证书的文件或目录路径。
- 默认值:
True
- --headers <headers>#
用于通过 http/s 将头部信息传递给 Ray 集群。请遵循 JSON 格式：{“key”: “value”}
- --log-style <log_style>#
如果设置为 'pretty'，输出带有格式和颜色。如果设置为 'record'，输出记录风格，没有格式。'auto' 默认使用 'pretty'，如果标准输入不是 TTY，则禁用漂亮日志记录。
- 选项:
auto | record | pretty
- --log-color <log_color>#
使用彩色日志记录。如果标准输出是 TTY，Auto 会启用彩色日志记录。
- 选项:
auto | false | true
- -v, --verbose#
参数
- JOB_ID#
必需参数