JobOperations Classe
Inicia uma instância do JobOperations
Essa classe não deve ser instanciada diretamente. Em vez disso, use o atributo jobs de um objeto MLClient.
- Herança
-
azure.ai.ml._scope_dependent_operations._ScopeDependentOperationsJobOperations
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>
Variáveis de escopo para as classes de operações de um objeto MLClient.
- operation_config
- <xref:azure.ai.ml._scope_dependent_operations.OperationConfig>
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>
Cliente de serviço para permitir que os usuários finais operem nos recursos do Workspace do Azure Machine Learning.
- all_operations
- <xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>
Todas as classes de operações de um objeto MLClient.
Métodos
archive |
Arquiva um trabalho. |
begin_cancel |
Cancela um trabalho. |
create_or_update |
Cria ou atualiza um trabalho. Se entidades como Ambiente ou Código forem definidas embutidas, elas serão criadas junto com o trabalho. |
download |
Baixa os logs e a saída de um trabalho. |
get |
Obtém um recurso de trabalho. |
list |
Lista trabalhos no workspace. |
restore |
Restaura um trabalho arquivado. |
show_services |
Obtém serviços associados ao nó de um trabalho. |
stream |
Transmite os logs de um trabalho em execução. |
validate |
Observação Esse é um método experimental e pode mudar a qualquer momento. Consulte https://aka.ms/azuremlexperimental para obter mais informações. Valida um objeto Job antes de enviar para o serviço. Ativos anônimos poderão ser criados se houver entidades definidas embutidas, como Componente, Ambiente e Código. Somente trabalhos de pipeline têm suporte para validação no momento. |
archive
Arquiva um trabalho.
archive(name: str) -> None
Parâmetros
Exceções
Gerado se nenhum trabalho com o nome fornecido puder ser encontrado.
Exemplos
Arquivar um trabalho.
ml_client.jobs.archive(name=job_name)
begin_cancel
Cancela um trabalho.
begin_cancel(name: str, **kwargs) -> LROPoller[None]
Parâmetros
Retornos
Um sondador para acompanhar a operação status.
Tipo de retorno
Exceções
Gerado se nenhum trabalho com o nome fornecido puder ser encontrado.
create_or_update
Cria ou atualiza um trabalho. Se entidades como Ambiente ou Código forem definidas embutidas, elas serão criadas junto com o trabalho.
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
O nome do experimento em que o trabalho será criado. Se None for fornecido, o trabalho será criado no experimento 'Default'.
- skip_validation
- bool
Especifica se a validação deve ou não ser ignorada antes de criar ou atualizar o trabalho. Observe que a validação para recursos dependentes, como um componente anônimo, não será ignorada. Usa False como padrão.
Retornos
Trabalho criado ou atualizado.
Tipo de retorno
Exceções
Gerado se o trabalho não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.
Gerado se os ativos de trabalho (por exemplo, dados, código, modelo, ambiente) não puderem ser validados com êxito. Os detalhes serão fornecidos na mensagem de erro.
Gerado se o modelo de trabalho não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.
Gerado se o objeto Job ou atributos formatados corretamente. Os detalhes serão fornecidos na mensagem de erro.
Gerado se o caminho local fornecido apontar para um diretório vazio.
Gerado se o Mecanismo do Docker não estiver disponível para o trabalho local.
Exemplos
Criando um novo trabalho e atualizando sua 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
Baixa os logs e a saída de um trabalho.
download(name: str, *, download_path: PathLike | str = '.', output_name: str | None = None, all: bool = False) -> None
Parâmetros
O caminho local a ser usado como o destino de download. O padrão é ".".
- all
- bool
Especifica se todos os logs e saídas nomeadas devem ser baixados. Usa False como padrão.
Exceções
Gerado se Job ainda não estiver em um estado terminal. Os detalhes serão fornecidos na mensagem de erro.
Gerado se logs e saídas não puderem ser baixados com êxito. Os detalhes serão fornecidos na mensagem de erro.
Exemplos
Baixando todos os logs e saídas nomeadas do trabalho "job-1" no 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 trabalho.
get(name: str) -> Job
Parâmetros
Retornos
Objeto de trabalho recuperado do serviço.
Tipo de retorno
Exceções
Gerado se nenhum trabalho com o nome fornecido puder ser encontrado.
Gerado se o parâmetro name não for uma cadeia de caracteres.
Exemplos
Recuperando um trabalho chamado "iris-dataset-job-1".
retrieved_job = ml_client.jobs.get(job_name)
list
Lista trabalhos no workspace.
list(*, parent_job_name: str | None = None, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY, **kwargs) -> Iterable[Job]
Parâmetros
Quando fornecido, retorna apenas trabalhos que são filhos do trabalho nomeado. O padrão é Nenhum, listando todos os trabalhos no workspace.
- list_view_type
- ListViewType
O tipo de exibição para incluir/excluir trabalhos arquivados. O padrão é ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY, excluindo trabalhos arquivados.
Retornos
Uma instância semelhante a um iterador de objetos Job.
Tipo de retorno
Exceções
Gerado se nenhum trabalho com o nome fornecido puder ser encontrado.
Exemplos
Recuperando uma lista dos trabalhos arquivados em um workspace com o trabalho pai chamado "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 um trabalho arquivado.
restore(name: str) -> None
Parâmetros
Exceções
Gerado se nenhum trabalho com o nome fornecido puder ser encontrado.
Exemplos
Restaurando um trabalho arquivado.
ml_client.jobs.restore(name=job_name)
show_services
Obtém serviços associados ao nó de um trabalho.
show_services(name: str, node_index: int = 0) -> Dict[str, ServiceInstance]
Parâmetros
Retornos
Os serviços associados ao trabalho para o nó fornecido.
Tipo de retorno
Exceções
Gerado se nenhum trabalho com o nome fornecido puder ser encontrado.
Exemplos
Recuperando os serviços associados ao 1º nó de um trabalho.
job_services = ml_client.jobs.show_services(job_name)
stream
Transmite os logs de um trabalho em execução.
stream(name: str) -> None
Parâmetros
Exceções
Gerado se nenhum trabalho com o nome fornecido puder ser encontrado.
Exemplos
Streaming de um trabalho 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
Observação
Esse é um método experimental e pode mudar a qualquer momento. Consulte https://aka.ms/azuremlexperimental para obter mais informações.
Valida um objeto Job antes de enviar para o serviço. Ativos anônimos poderão ser criados se houver entidades definidas embutidas, como Componente, Ambiente e Código. Somente trabalhos de pipeline têm suporte para validação no momento.
validate(job: Job, *, raise_on_failure: bool = False, **kwargs) -> ValidationResult
Parâmetros
- raise_on_failure
- bool
Especifica se um erro deve ser gerado se a validação falhar. Usa False como padrão.
Retornos
Um objeto ValidationResult que contém todos os erros encontrados.
Tipo de retorno
Exceções
Gerado se nenhum trabalho com o nome fornecido puder ser encontrado.
Exemplos
Validando um objeto PipelineJob e imprimindo 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)
Azure SDK for Python