ray.job_submission.JobSubmissionClient

class ray.job_submission.JobSubmissionClient(address: str | None = None, create_cluster_if_needed: bool = False, cookies: Dict[str, Any] | None = None, metadata: Dict[str, Any] | None = None, headers: Dict[str, Any] | None = None, verify: str | bool | None = True)

基类：SubmissionClient

一个用于在远程集群上提交和交互作业的本地客户端。

通过REST API向集群上的作业服务器提交HTTP请求。

参数:

• address – 可以是 (1) Ray 集群的地址，或者是 (2) 头节点上仪表盘服务器的 HTTP 地址，例如 “http://<head-node-ip>:8265”。如果是 (1)，它必须指定为一个可以传递给 ray.init() 的地址，例如 Ray Client 地址 (ray://<head_node_host>:10001)，或者是 “auto”，或者是 “localhost:<port>”。如果未指定，将尝试连接到正在运行的本地 Ray 集群。此参数总是被 RAY_ADDRESS 环境变量覆盖。

• create_cluster_if_needed – 指示指定地址的集群是否需要已经运行。Ray 在与作业交互之前不会启动集群，但第三方作业管理器可能会这样做。

• cookies – 发送请求到HTTP作业服务器时使用的Cookies。

• metadata – 与所有作业一起存储的任意元数据。每个作业指定的新元数据将与通过简单字典更新提供的全局元数据合并。

• headers – 在向HTTP作业服务器发送请求时使用的头信息，用于远程集群的身份验证等场景。

• verify – 布尔值指示以验证服务器的TLS证书，或指向受信任证书文件或目录的路径。默认值：True。

方法

delete_job	删除处于终端状态的作业及其所有关联数据。
get_address	开发者API: 此API可能会在Ray的次要版本之间发生变化。
get_job_info	获取与作业相关的最新状态和其他信息。
get_job_logs	获取由作业生成的所有日志。
get_job_status	获取作业的最新状态。
get_version	PublicAPI (测试版): 此API目前处于测试阶段，在成为稳定版本之前可能会发生变化。
list_jobs	列出所有作业及其状态和其他信息。
stop_job	请求一个作业异步退出。
submit_job	异步提交并执行作业。
tail_job_logs	获取一个跟随作业日志的迭代器。