JobOperations Classe

Inicia uma instância de JobOperations

Esta classe não deve ser instanciada diretamente. Em vez disso, utilize o atributo tarefas de um objeto MLClient.

Herança

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

Construtor

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

Parâmetros

operation_scope

<xref:azure.ai.ml._scope_dependent_operations.OperationScope>

Necessário

Variáveis de âmbito para as classes de operações de um objeto MLClient.

operation_config

<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>

Necessário

Configuração comum para classes de operações de um objeto MLClient.

service_client_02_2023_preview

<xref:azure.ai.ml._restclient.v2023_02_01_preview.AzureMachineLearningWorkspaces>

Necessário

Cliente de serviço para permitir que os utilizadores finais operem em recursos da Área de Trabalho do Azure Machine Learning.

all_operations

<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>

Necessário

Todas as classes de operações de um objeto MLClient.

credential

TokenCredential

Necessário

Credencial a utilizar para autenticação.

Métodos

archive	Arquiva uma tarefa.
begin_cancel	Cancela uma tarefa.
create_or_update	Cria ou atualiza uma tarefa. Se entidades como o Ambiente ou o Código estiverem definidas inline, serão criadas juntamente com a tarefa.
download	Transfere os registos e a saída de uma tarefa.
get	Obtém um recurso de tarefa.
list	Lista tarefas na área de trabalho.
restore	Restaura uma tarefa arquivada.
show_services	Obtém serviços associados ao nó de uma tarefa.
stream	Transmite os registos de uma tarefa em execução.
validate	Nota Este é um método experimental e pode ser alterado em qualquer altura. Para obter mais informações, veja https://aka.ms/azuremlexperimental. Valida um objeto tarefa antes de submeter para o serviço. Podem ser criados recursos anónimos se existirem entidades definidas inline, como Componente, Ambiente e Código. Apenas as tarefas de pipeline são suportadas para validação atualmente.

archive

Arquiva uma tarefa.

archive(name: str) -> None

Parâmetros

name

str

Necessário

O nome da tarefa.

Exceções

ResourceNotFoundError

Gerado se não for possível encontrar nenhum trabalho com o nome especificado.

Exemplos

Arquivar um trabalho.

   ml_client.jobs.archive(name=job_name)

begin_cancel

Cancela uma tarefa.

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

Parâmetros

name

str

Necessário

O nome da tarefa.

Devoluções

Um poller para controlar o estado da operação.

Tipo de retorno

LROPoller[None]

Exceções

ResourceNotFoundError

Gerado se não for possível encontrar nenhum trabalho com o nome especificado.

create_or_update

Cria ou atualiza uma tarefa. Se entidades como o Ambiente ou o Código estiverem definidas inline, serão criadas juntamente com a tarefa.

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

Parâmetros

job

Job

Necessário

O objeto de tarefa.

description

Optional[str]

A descrição da tarefa.

compute

Optional[str]

O destino de computação da tarefa.

tags

Optional[dict]

As etiquetas da tarefa.

experiment_name

Optional[str]

O nome da experimentação em que a tarefa será criada. Se Nenhum for fornecido, a tarefa será criada na experimentação "Predefinição".

skip_validation

bool

Especifica se deve ou não ignorar a validação antes de criar ou atualizar a tarefa. Tenha em atenção que a validação de recursos dependentes, como um componente anónimo, não será ignorada. A predefinição é Falso.

Devoluções

Tarefa criada ou atualizada.

Tipo de retorno

Job

Exceções

Union

UserErrorException

ValidationException

Gerado se a Tarefa não puder ser validada com êxito. Os detalhes serão fornecidos na mensagem de erro.

AssetException

Gerado se os recursos da tarefa (por exemplo, Dados, Código, Modelo, Ambiente) não puderem ser validados com êxito. Os detalhes serão fornecidos na mensagem de erro.

ModelException

Gerado se o Modelo de tarefa não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

JobException

Gerado se o objeto ou atributos da tarefa estiverem corretamente formatados. Os detalhes serão fornecidos na mensagem de erro.

EmptyDirectoryError

Gerado se o caminho local fornecido apontar para um diretório vazio.

DockerEngineNotAvailableError

Gerado se o Motor do Docker não estiver disponível para tarefa local.

Exemplos

Criar uma nova tarefa e, em seguida, atualizar a computação.

   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

Transfere os registos e a saída de uma tarefa.

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

Parâmetros

name

str

Necessário

O nome de um trabalho.

download_path

Union[<xref:PathLike>, str]

O caminho local a utilizar como destino de transferência. A predefinição é ".".

output_name

Optional[str]

O nome da saída a transferir. A predefinição é Nenhuma.

all

bool

Especifica se todos os registos e saídas com nome devem ser transferidos. A predefinição é Falso.

Exceções

JobException

Gerado se Job ainda não estiver num estado terminal. Os detalhes serão fornecidos na mensagem de erro.

MlException

Gerado se os registos e as saídas não puderem ser transferidos com êxito. Os detalhes serão fornecidos na mensagem de erro.

Exemplos

Transferir todos os registos e saídas nomeadas da tarefa "job-1" para o diretório local "job-1-logs".

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

get

Obtém um recurso de tarefa.

get(name: str) -> Job

Parâmetros

name

str

Necessário

O nome da tarefa.

Devoluções

Objeto de tarefa obtido do serviço.

Tipo de retorno

Job

Exceções

ResourceNotFoundError

Gerado se não for possível encontrar nenhum trabalho com o nome especificado.

UserErrorException

Gerado se o parâmetro name não for uma cadeia.

Exemplos

A obter uma tarefa com o nome "iris-dataset-job-1".

   retrieved_job = ml_client.jobs.get(job_name)

list

Lista tarefas na área de trabalho.

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

Parâmetros

parent_job_name

Optional[str]

Quando fornecido, só devolve tarefas subordinadas da tarefa nomeada. A predefinição é Nenhuma, listando todas as tarefas na área de trabalho.

list_view_type

ListViewType

O tipo de vista para incluir/excluir tarefas arquivadas. A predefinição é ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY, excluindo tarefas arquivadas.

Devoluções

Uma instância semelhante a iterador de objetos de Tarefa.

Tipo de retorno

ItemPaged[Job]

Exceções

ResourceNotFoundError

Gerado se não for possível encontrar nenhum trabalho com o nome especificado.

Exemplos

Obter uma lista das tarefas arquivadas numa área de trabalho com a tarefa principal denominada "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

Restaura uma tarefa arquivada.

restore(name: str) -> None

Parâmetros

name

str

Necessário

O nome da tarefa.

Exceções

ResourceNotFoundError

Gerado se não for possível encontrar nenhum trabalho com o nome especificado.

Exemplos

Restaurar uma tarefa arquivada.

   ml_client.jobs.restore(name=job_name)

show_services

Obtém serviços associados ao nó de uma tarefa.

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

Parâmetros

name

str

Necessário

O nome da tarefa.

node_index

int

Necessário

O índice do nó (baseado em zero). A predefinição é 0.

Devoluções

Os serviços associados à tarefa para o nó especificado.

Tipo de retorno

dict[str, ServiceInstance]

Exceções

ResourceNotFoundError

Gerado se não for possível encontrar nenhum trabalho com o nome especificado.

Exemplos

Obter os serviços associados ao 1º nó de uma tarefa.

   job_services = ml_client.jobs.show_services(job_name)

stream

Transmite os registos de uma tarefa em execução.

stream(name: str) -> None

Parâmetros

name

str

Necessário

O nome da tarefa.

Exceções

ResourceNotFoundError

Gerado se não for possível encontrar nenhum trabalho com o nome especificado.

Exemplos

Transmitir em fluxo uma tarefa em execução.

   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

Nota

Este é um método experimental e pode ser alterado em qualquer altura. Para obter mais informações, veja https://aka.ms/azuremlexperimental.

Valida um objeto tarefa antes de submeter para o serviço. Podem ser criados recursos anónimos se existirem entidades definidas inline, como Componente, Ambiente e Código. Apenas as tarefas de pipeline são suportadas para validação atualmente.

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

Parâmetros

job

Job

Necessário

O objeto de tarefa a validar.

raise_on_failure

bool

Especifica se deve ser gerado um erro se a validação falhar. A predefinição é Falso.

Devoluções

Um objeto ValidationResult que contém todos os erros encontrados.

Tipo de retorno

ValidationResult

Exceções

ResourceNotFoundError

Gerado se não for possível encontrar nenhum trabalho com o nome especificado.

Exemplos

Validar um objeto PipelineJob e imprimir os erros encontrados.

   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)