Partilhar via

CommandJob Classe

  • Referência

Tarefa 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 só de leitura sobre serviços associados à tarefa.

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

Mapeamento de enlaces de dados de saída utilizados no comando .

outputs
Optional[dict[str, Output]]

Mapeamento de enlaces de dados de saída utilizados na tarefa.

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

A identidade que a tarefa utilizará durante a execução na computação.

limits
Optional[CommandJobLimits]

Os limites da tarefa.

kwargs
dict

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

Exemplos

Configurar 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

Captura o conteúdo da tarefa num ficheiro no formato YAML.

dump

Captura o conteúdo da tarefa num ficheiro no formato YAML.

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

Parâmetros

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
Necessário

O caminho local ou o fluxo de ficheiros no qual escrever o conteúdo YAML. Se dest for um caminho de ficheiro, será criado um novo ficheiro. Se dest for um ficheiro aberto, o ficheiro será escrito diretamente.

kwargs
dict

Argumentos adicionais a transmitir para o serializador YAML.

Exceções

FileExistsError

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

IOError

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

Atributos

base_path

O caminho base do recurso.

Devoluções

O caminho base do recurso.

Tipo de retorno

str

creation_context

O contexto de criação do recurso.

Devoluções

Os metadados de criação do recurso.

Tipo de retorno

Optional[SystemData]

distribution

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

Devoluções

A configuração de distribuição.

Tipo de retorno

Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]

id

O ID do recurso.

Devoluções

O ID global do recurso, um ID de Resource Manager do Azure (ARM).

Tipo de retorno

Optional[str]

inputs

log_files

Ficheiros de saída da tarefa.

Devoluções

O dicionário de nomes de registo e URLs.

Tipo de retorno

Optional[Dict[str, str]]

outputs

parameters

Parâmetros do MLFlow.

Devoluções

Parâmetros do MLFlow com sessão iniciada.

Tipo de retorno

dict[str, str]

resources

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

Devoluções

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

Tipo de retorno

JobResourceConfiguration

status

O estado da tarefa.

Os valores comuns devolvidos incluem "Em Execução", "Concluído" e "Com Falhas". Todos os valores possíveis são:

  • NotStarted - Este é um estado temporário em que os objetos Run do lado do cliente estão antes da submissão da cloud.

  • A iniciar – a Execução começou a ser processada na cloud. O autor da chamada tem um ID de execução neste momento.

  • Aprovisionamento – a computação a pedido está a ser criada para uma determinada submissão de trabalho.

  • Preparação – o ambiente de execução está a ser preparado e encontra-se numa de duas fases:

    • Compilação da imagem do Docker

    • configuração do ambiente conda

  • Em fila – a tarefa está em fila de espera no destino de computação. Por exemplo, no BatchAI, a tarefa está num estado em fila

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

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

  • Finalização – a execução do código do utilizador foi concluída e a execução encontra-se em fases de pós-processamento.

  • CancelRequested - Foi pedido o cancelamento para a tarefa.

  • Concluído – a execução foi concluída com êxito. Isto inclui a execução do código do utilizador e a execução

    fases de pós-processamento.

  • Falha – a execução falhou. Normalmente, a propriedade Error numa execução irá fornecer detalhes sobre o motivo.

  • Cancelado – segue um pedido de cancelamento e indica que a execução foi cancelada com êxito.

  • NotResponding – para execuções com Heartbeats ativados, não foi enviado nenhum heartbeat recentemente.

Devoluções

Estado da tarefa.

Tipo de retorno

Optional[str]

studio_url

Ponto final do Azure ML Studio.

Devoluções

O URL para a página de detalhes da tarefa.

Tipo de retorno

Optional[str]

type

O tipo de tarefa.

Devoluções

O tipo de tarefa.

Tipo de retorno

Optional[str]