通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Job 类

  • 参考

作业的基类。

不应直接实例化此类。 请改用其子类之一。

继承
azure.ai.ml.entities._resource.Resource
Job
azure.ai.ml.entities._job.pipeline._component_translatable.ComponentTranslatableMixin
Job
azure.ai.ml.entities._mixins.TelemetryMixin
Job

构造函数

Job(name: str | None = None, display_name: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, experiment_name: str | None = None, compute: str | None = None, services: Dict[str, JobService] | None = None, **kwargs: Dict)

参数

name
Optional[str]
默认值: None

作业的名称。

display_name
Optional[str]
默认值: None

作业的显示名称。

description
Optional[str]
默认值: None

作业的说明。

tags
Optional[dict[str, str]]
默认值: None

标记字典。 可以添加、删除和更新标记。

properties
Optional[dict[str, str]]
默认值: None

作业属性字典。

experiment_name
Optional[str]
默认值: None

将创建作业的试验的名称。 默认为当前目录的名称。

services
Optional[dict[str, JobService]]
默认值: None

有关与作业关联的服务的信息。

compute
Optional[str]
默认值: None

有关与作业关联的计算资源的信息。

kwargs
dict

其他配置参数的字典。

方法

dump

将作业内容转储到 YAML 格式的文件中。

dump

将作业内容转储到 YAML 格式的文件中。

dump(dest: str | PathLike | IO, **kwargs) -> None

参数

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
必需

要向其写入 YAML 内容的本地路径或文件流。 如果 dest 是文件路径，则将创建一个新文件。 如果 dest 是打开的文件，则将直接写入该文件。

kwargs
dict

要传递给 YAML 序列化程序的其他参数。

例外

FileExistsError

如果 dest 是文件路径且文件已存在，则引发。

IOError

如果 dest 是打开的文件且文件不可写，则引发。

属性

base_path

资源的基路径。

返回

资源的基路径。

返回类型

str

creation_context

资源的创建上下文。

返回

资源的创建元数据。

返回类型

Optional[SystemData]

id

资源 ID。

返回

资源的全局 ID，Azure 资源管理器 (ARM) ID。

返回类型

Optional[str]

log_files

作业输出文件。

返回

日志名称和 URL 的字典。

返回类型

Optional[Dict[str, str]]

status

作业的状态。

返回的常见值包括“正在运行”、“已完成”和“失败”。 所有可能的值为：

  • NotStarted - 这是客户端 Run 对象在云提交之前处于的临时状态。

  • 正在启动 - 运行已开始在云中处理。 调用方此时具有运行 ID。

  • 预配 - 正在为给定的作业提交创建按需计算。

  • 准备 - 运行环境正在准备中，处于以下两个阶段之一：

    • Docker 映像生成

    • Conda 环境设置

  • 已排队 - 作业在计算目标上排队。 例如，在 BatchAI 中，作业处于排队状态

    等待所有请求的节点准备就绪时。

  • 正在运行 - 作业已开始在计算目标上运行。

  • 正在完成 - 用户代码执行已完成，运行处于后处理阶段。

  • 已请求取消 - 已请求取消作业。

  • 已完成 - 运行已成功完成。 这包括用户代码执行和运行

    后期处理阶段。

  • 失败 - 运行失败。 通常，运行上的 Error 属性会提供有关原因的详细信息。

  • 已取消 - 遵循取消请求并指示运行现已成功取消。

  • 未响应 - 对于启用了检测信号的运行，最近未发送任何检测信号。

返回

作业的状态。

返回类型

Optional[str]

studio_url

Azure ML Studio 终结点。

返回

作业详细信息页的 URL。

返回类型

Optional[str]

type

作业的类型。

返回

作业的类型。

返回类型

Optional[str]