JobOperations 类

存档作业。

archive(name: str) -> None

参数

例外

如果未找到具有给定名称的作业，则引发。

示例

存档作业。

   ml_client.jobs.archive(name=job_name)

取消作业。

begin_cancel(name: str, **kwargs) -> LROPoller[None]

参数

返回

用于跟踪操作状态的轮询程序。

返回类型

例外

如果未找到具有给定名称的作业，则引发。

创建或更新作业。 如果环境或代码等实体是内联定义的，则会与作业一起创建它们。

create_or_update(job: Job, *, description: str | None = None, compute: str | None = None, tags: dict | None = None, experiment_name: str | None = None, skip_validation: bool = False, **kwargs) -> Job

参数

返回

已创建或更新作业。

返回类型

例外

如果无法成功验证作业，则引发。 错误消息中将提供详细信息。

如果无法成功验证作业资产 (例如数据、代码、模型、环境) ，则引发此事件。 错误消息中将提供详细信息。

如果无法成功验证作业模型，则引发。 错误消息中将提供详细信息。

如果 Job 对象或属性的格式正确，则引发。 错误消息中将提供详细信息。

如果提供的本地路径指向空目录，则引发。

如果 Docker 引擎不可用于本地作业，则引发。

示例

创建新作业，然后更新其计算。

   from azure.ai.ml import load_job

   created_job = ml_client.jobs.create_or_update(
       name=job_name,
       job=load_job(
           "./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml",
           params_override=[{"name": job_name}, {"compute": "cpucluster"}],
       ),
   )

下载作业的日志和输出。

download(name: str, *, download_path: PathLike | str = '.', output_name: str | None = None, all: bool = False) -> None

参数

例外

如果作业尚未处于终端状态，则引发。 错误消息中将提供详细信息。

如果无法成功下载日志和输出，则引发。 错误消息中将提供详细信息。

示例

将作业“job-1”的所有日志和命名输出下载到本地目录“job-1-logs”。

   ml_client.jobs.download(name=job_name, download_path="./job-1-logs", all=True)

获取作业资源。

get(name: str) -> Job

参数

返回

从服务检索到的作业对象。

返回类型

例外

如果未找到具有给定名称的作业，则引发。

如果 name 参数不是字符串，则引发。

示例

检索名为“iris-dataset-job-1”的作业。

   retrieved_job = ml_client.jobs.get(job_name)

列出工作区中的作业。

list(*, parent_job_name: str | None = None, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY, **kwargs) -> Iterable[Job]

参数

返回

类似于 Job 对象的迭代器实例。

返回类型

例外

如果未找到具有给定名称的作业，则引发。

示例

检索工作区中具有名为“iris-dataset-jobs”的父作业的已存档作业的列表。

   from azure.ai.ml._restclient.v2023_04_01_preview.models import ListViewType

   list_of_jobs = ml_client.jobs.list(parent_job_name=job_name, list_view_type=ListViewType.ARCHIVED_ONLY)

还原存档的作业。

restore(name: str) -> None

参数

例外

如果未找到具有给定名称的作业，则引发。

示例

还原存档作业。

   ml_client.jobs.restore(name=job_name)

获取与作业节点关联的服务。

show_services(name: str, node_index: int = 0) -> Dict[str, ServiceInstance]

参数

返回

与给定节点的作业关联的服务。

返回类型

例外

如果未找到具有给定名称的作业，则引发。

示例

检索与作业的第一个节点关联的服务。

   job_services = ml_client.jobs.show_services(job_name)

流式传输正在运行的作业的日志。

stream(name: str) -> None

参数

例外

如果未找到具有给定名称的作业，则引发。

示例

流式处理正在运行的作业。

   running_job = ml_client.jobs.create_or_update(
       load_job(
           "./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml",
           params_override=[{"name": job_name}, {"compute": "cpucluster"}],
       )
   )
   ml_client.jobs.stream(running_job.name)

在提交到服务之前验证 Job 对象。 如果存在内联定义的实体（如组件、环境和代码），则可能会创建匿名资产。 目前仅支持管道作业进行验证。

validate(job: Job, *, raise_on_failure: bool = False, **kwargs) -> ValidationResult

参数

返回

包含所有找到的错误的 ValidationResult 对象。

返回类型

例外

如果未找到具有给定名称的作业，则引发。

示例

验证 PipelineJob 对象并打印出找到的错误。

   from azure.ai.ml import load_job
   from azure.ai.ml.entities import PipelineJob

   pipeline_job: PipelineJob = load_job(
       "./sdk/ml/azure-ai-ml/tests/test_configs/pipeline_jobs/invalid/combo.yml",
       params_override=[{"name": job_name}, {"compute": "cpucluster"}],
   )
   print(ml_client.jobs.validate(pipeline_job).error_messages)