Compartilhar via

CommandJob Classe

  • Referência

Trabalho de comando.

Herança
azure.ai.ml.entities._job.job.Job
CommandJob
azure.ai.ml.entities._job.parameterized_command.ParameterizedCommand
CommandJob
azure.ai.ml.entities._job.job_io_mixin.JobIOMixin
CommandJob

Construtor

CommandJob(*, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, Output] | None = None, limits: CommandJobLimits | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, services: Dict[str, JobService | JupyterLabJobService | SshJobService | TensorBoardJobService | VsCodeJobService] | None = None, **kwargs)

Parâmetros

services
Optional[dict[str, JobService]]

Informações somente leitura sobre os serviços associados ao trabalho.

inputs
Optional[dict[str, Union[Input, str, bool, int, float]]]

Mapeamento de associações de dados de saída usadas no comando .

outputs
Optional[dict[str, Output]]

Mapeamento de associações de dados de saída usadas no trabalho.

identity
Optional[Union[ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration]]

A identidade que o trabalho usará durante a execução na computação.

limits
Optional[CommandJobLimits]

Os limites para o trabalho.

kwargs
dict

Um dicionário de parâmetros de configuração adicionais.

Exemplos

Configurando um CommandJob.


   command_job = CommandJob(
       code="./src",
       command="python train.py --ss {search_space.ss}",
       inputs={"input1": Input(path="trial.csv")},
       outputs={"default": Output(path="./foo")},
       compute="trial",
       environment="AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33",
       limits=CommandJobLimits(timeout=120),
   )

Métodos

dump

Despeja o conteúdo do trabalho em um arquivo no formato YAML.

dump

Despeja o conteúdo do trabalho em um arquivo no formato YAML.

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

Parâmetros

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
Obrigatório

O caminho local ou o fluxo de arquivos no qual gravar o conteúdo YAML. Se dest for um caminho de arquivo, um novo arquivo será criado. Se dest for um arquivo aberto, o arquivo será gravado diretamente.

kwargs
dict

Argumentos adicionais a serem passados para o serializador YAML.

Exceções

FileExistsError

Gerado se dest for um caminho de arquivo e o arquivo já existir.

IOError

Gerado se dest for um arquivo aberto e o arquivo não for gravável.

Atributos

base_path

O caminho base do recurso.

Retornos

O caminho base do recurso.

Tipo de retorno

str

creation_context

O contexto de criação do recurso.

Retornos

Os metadados de criação para o recurso.

Tipo de retorno

Optional[SystemData]

distribution

A configuração do trabalho ou componente de comando distribuído.

Retornos

A configuração de distribuição.

Tipo de retorno

Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]

id

A ID do recurso.

Retornos

A ID global do recurso, uma ID do ARM (Resource Manager do Azure).

Tipo de retorno

Optional[str]

inputs

log_files

Arquivos de saída do trabalho.

Retornos

O dicionário de nomes de log e URLs.

Tipo de retorno

Optional[Dict[str, str]]

outputs

parameters

Parâmetros do MLFlow.

Retornos

Parâmetros do MLFlow registrados no trabalho.

Tipo de retorno

dict[str, str]

resources

A configuração de recurso de computação para o componente de comando ou trabalho.

Retornos

A configuração de recurso de computação para o componente de comando ou trabalho.

Tipo de retorno

JobResourceConfiguration

status

O status do trabalho.

Os valores comuns retornados incluem "Running", "Completed" e "Failed". Todos os valores possíveis são:

  • NotStarted - Esse é um estado temporário em que os objetos Run do lado do cliente estão antes do envio à nuvem.

  • Starting – A Execução começou a ser processada na nuvem. O chamador tem uma ID de execução neste ponto.

  • Provisionamento – a computação sob demanda está sendo criada para um determinado envio de trabalho.

  • Preparando – o ambiente de execução está sendo preparado e está em um dos dois estágios:

    • Build de imagem do Docker

    • conda environment setup

  • Enfileirado – o trabalho está na fila no destino de computação. Por exemplo, no BatchAI, o trabalho está em um estado enfileirado

    enquanto aguarda que todos os nós solicitados estejam prontos.

  • Em execução – o trabalho começou a ser executado no destino de computação.

  • Finalização – a execução do código do usuário foi concluída e a execução está em estágios de pós-processamento.

  • CancelRequested – O cancelamento foi solicitado para o trabalho.

  • Concluído – a execução foi concluída com êxito. Isso inclui a execução e a execução do código do usuário

    estágios de pós-processamento.

  • Failed – A execução falhou. Normalmente, a propriedade de Erro em uma execução fornecerá detalhes sobre o motivo.

  • Canceled – Segue uma solicitação de cancelamento e indica que a execução foi cancelada com êxito.

  • NotResponding – Para execuções que têm Pulsações habilitadas, nenhuma pulsação foi enviada recentemente.

Retornos

Status do trabalho.

Tipo de retorno

Optional[str]

studio_url

Ponto de extremidade do Estúdio do Azure ML.

Retornos

A URL para a página de detalhes do trabalho.

Tipo de retorno

Optional[str]

type

O tipo do trabalho.

Retornos

O tipo do trabalho.

Tipo de retorno

Optional[str]