Поделиться через

JobOperations Класс

  • Ссылка

Инициирует экземпляр JobOperations.

Экземпляр этого класса не следует создавать напрямую. Вместо этого используйте атрибут jobs объекта MLClient.

Наследование
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
JobOperations

Конструктор

JobOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client_02_2023_preview: AzureMachineLearningWorkspaces, all_operations: OperationsContainer, credential: TokenCredential, **kwargs: Any)

Параметры

operation_scope
<xref:azure.ai.ml._scope_dependent_operations.OperationScope>
Обязательно

Переменные области для классов операций объекта MLClient.

operation_config
<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>
Обязательно

Общая конфигурация для классов операций объекта MLClient.

service_client_02_2023_preview
<xref:azure.ai.ml._restclient.v2023_02_01_preview.AzureMachineLearningWorkspaces>
Обязательно

Клиент службы, позволяющий конечным пользователям работать с ресурсами рабочей области машинного обучения Azure.

all_operations
<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>
Обязательно

Все классы операций объекта MLClient.

credential
TokenCredential
Обязательно

Учетные данные, используемые для проверки подлинности.

Методы

archive

Архивирует задание.
begin_cancel

Отменяет задание.
create_or_update

Создает или обновляет задание. Если такие сущности, как Среда или Код, определены в встроенном коде, они будут созданы вместе с заданием.
download

Скачивает журналы и выходные данные задания.
get

Возвращает ресурс задания.
list

Список заданий в рабочей области.
restore

Восстанавливает архивированное задание.
show_services

Возвращает службы, связанные с узлом задания.
stream

Выполняет потоковую передачу журналов выполняющегося задания.
validate

Примечание

Это экспериментальный метод, который может быть изменен в любое время. Дополнительные сведения см. по адресу https://aka.ms/azuremlexperimental.

Проверяет объект Job перед отправкой в службу. Анонимные ресурсы могут создаваться при наличии встроенных определенных сущностей, таких как Компонент, Среда и Код. В настоящее время для проверки поддерживаются только задания конвейера.

archive

Архивирует задание.

archive(name: str) -> None

Параметры

name
str
Обязательно

Имя задания.

Исключения

ResourceNotFoundError

Возникает, если не удается найти задание с заданным именем.

Примеры

Архивация задания.


   ml_client.jobs.archive(name=job_name)

begin_cancel

Отменяет задание.

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

Параметры

name
str
Обязательно

Имя задания.

Возвращаемое значение

Средство опроса для отслеживания состояния операции.

Возвращаемый тип

LROPoller[None]

Исключения

ResourceNotFoundError

Возникает, если не удается найти задание с заданным именем.

create_or_update

Создает или обновляет задание. Если такие сущности, как Среда или Код, определены в встроенном коде, они будут созданы вместе с заданием.

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
Job
Обязательно

Объект задания.

description
Optional[str]

Описание задания.

compute
Optional[str]

Целевой объект вычислений для задания.

tags
Optional[dict]

Теги для задания.

experiment_name
Optional[str]

Имя эксперимента, в который будет создано задание. Если указано значение None, задание будет создано в эксперименте "По умолчанию".

skip_validation
bool

Указывает, следует ли пропускать проверку перед созданием или обновлением задания. Обратите внимание, что проверка зависимых ресурсов, таких как анонимный компонент, не будет пропущена. Значение по умолчанию — False.

Возвращаемое значение

Созданное или обновленное задание.

Возвращаемый тип

Job

Исключения

Union
UserErrorException
ValidationException

Возникает, если задание не может быть успешно проверено. Подробные сведения будут указаны в сообщении об ошибке.

AssetException

Возникает, если ресурсы задания (например, данные, код, модель, среда) не могут быть успешно проверены. Подробные сведения будут указаны в сообщении об ошибке.

ModelException

Возникает, если модель задания не может быть успешно проверена. Подробные сведения будут указаны в сообщении об ошибке.

JobException

Возникает, если объект задания или атрибуты правильно отформатированы. Подробные сведения будут указаны в сообщении об ошибке.

EmptyDirectoryError

Возникает, если локальный путь указывает на пустой каталог.

DockerEngineNotAvailableError

Возникает, если подсистема 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

Скачивает журналы и выходные данные задания.

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

Параметры

name
str
Обязательно

Имя задания.

download_path
Union[<xref:PathLike>, str]

Локальный путь, используемый в качестве места назначения загрузки. По умолчанию — ".".

output_name
Optional[str]

Имя выходных данных для скачивания. Значение по умолчанию — None (Нет).

all
bool

Указывает, следует ли скачивать все журналы и именованные выходные данные. Значение по умолчанию — False.

Исключения

JobException

Возникает, если задание еще не находится в конечном состоянии. Подробные сведения будут указаны в сообщении об ошибке.

MlException

Возникает, если не удается скачать журналы и выходные данные. Подробные сведения будут указаны в сообщении об ошибке.

Примеры

Скачивание всех журналов и именованных выходных данных задания job-1 в локальный каталог job-1-logs.


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

get

Возвращает ресурс задания.

get(name: str) -> Job

Параметры

name
str
Обязательно

Имя задания.

Возвращаемое значение

Объект задания, полученный из службы.

Возвращаемый тип

Job

Исключения

ResourceNotFoundError

Возникает, если не удается найти задание с заданным именем.

UserErrorException

Возникает, если параметр name не является строкой.

Примеры

Получение задания с именем iris-dataset-job-1.


   retrieved_job = ml_client.jobs.get(job_name)

list

Список заданий в рабочей области.

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

Параметры

parent_job_name
Optional[str]

При указании возвращает только задания, которые являются дочерними элементами именованного задания. Значение по умолчанию — Нет, список всех заданий в рабочей области.

list_view_type
ListViewType

Тип представления для включения или исключения архивных заданий. По умолчанию используется значение ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY, за исключением архивных заданий.

Возвращаемое значение

Экземпляр объектов Job, похожий на итератор.

Возвращаемый тип

ItemPaged[Job]

Исключения

ResourceNotFoundError

Возникает, если не удается найти задание с заданным именем.

Примеры

Получение списка архивированных заданий в рабочей области с родительским заданием с именем 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

Восстанавливает архивированное задание.

restore(name: str) -> None

Параметры

name
str
Обязательно

Имя задания.

Исключения

ResourceNotFoundError

Возникает, если не удается найти задание с заданным именем.

Примеры

Восстановление архивного задания.


   ml_client.jobs.restore(name=job_name)

show_services

Возвращает службы, связанные с узлом задания.

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

Параметры

name
str
Обязательно

Имя задания.

node_index
int
Обязательно

Индекс узла (отсчитываемый от нуля). Значение по умолчанию — 0.

Возвращаемое значение

Службы, связанные с заданием для данного узла.

Возвращаемый тип

dict[str, ServiceInstance]

Исключения

ResourceNotFoundError

Возникает, если не удается найти задание с заданным именем.

Примеры

Получение служб, связанных с 1-м узлом задания.


   job_services = ml_client.jobs.show_services(job_name)

stream

Выполняет потоковую передачу журналов выполняющегося задания.

stream(name: str) -> None

Параметры

name
str
Обязательно

Имя задания.

Исключения

ResourceNotFoundError

Возникает, если не удается найти задание с заданным именем.

Примеры

Потоковая передача выполняющихся заданий.


   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)

validate

Примечание

Это экспериментальный метод, который может быть изменен в любое время. Дополнительные сведения см. по адресу https://aka.ms/azuremlexperimental.

Проверяет объект Job перед отправкой в службу. Анонимные ресурсы могут создаваться при наличии встроенных определенных сущностей, таких как Компонент, Среда и Код. В настоящее время для проверки поддерживаются только задания конвейера.

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

Параметры

job
Job
Обязательно

Проверяемый объект задания.

raise_on_failure
bool

Указывает, следует ли вызывать ошибку в случае сбоя проверки. Значение по умолчанию — False.

Возвращаемое значение

Объект ValidationResult, содержащий все найденные ошибки.

Возвращаемый тип

ValidationResult

Исключения

ResourceNotFoundError

Возникает, если не удается найти задание с заданным именем.

Примеры

Проверка объекта 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)