Partilhar via


PipelineJob Classe

Tarefa de pipeline.

Não deve instanciar esta classe diretamente. Em vez disso, deve utilizar o decorador de @pipeline para criar um PipelineJob.

] computação :p aram: nome de destino de computação do pipeline criado. Predefinições para None :type compute: str :p aram tags: Dicionário de etiquetas. As etiquetas podem ser adicionadas, removidas e atualizadas. Predefinições para None :type tags: dict[str, str] :p aram kwargs: um dicionário de parâmetros de configuração adicionais. Predefinições para None :type kwargs: dict

Herança
azure.ai.ml.entities._job.job.Job
PipelineJob
azure.ai.ml.entities._mixins.YamlTranslatableMixin
PipelineJob
azure.ai.ml.entities._job.pipeline._io.mixin.PipelineJobIOMixin
PipelineJob
azure.ai.ml.entities._validation.path_aware_schema.PathAwareSchemaValidatableMixin
PipelineJob

Construtor

PipelineJob(*, component: str | PipelineComponent | None = None, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, Output] | None = None, name: str | None = None, description: str | None = None, display_name: str | None = None, experiment_name: str | None = None, jobs: Dict[str, BaseNode] | None = None, settings: PipelineJobSettings | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, compute: str | None = None, tags: Dict[str, str] | None = None, **kwargs)

Parâmetros

component
Union[str, PipelineComponent]
Necessário

Versão do componente do pipeline. O campo é mutuamente exclusivo com "empregos".

inputs
dict[str, Union[<xref:azure.ai.ml.entities.Input>, str, bool, int, float]]
Necessário

Entradas para a tarefa de pipeline.

outputs
dict[str, <xref:azure.ai.ml.entities.Output>]
Necessário

Saídas da tarefa de pipeline.

name
str
Necessário

Nome do PipelineJob. Predefinições para Nenhum

description
str
Necessário

Descrição da tarefa de pipeline. Predefinições para Nenhum

display_name
str
Necessário

Nome a apresentar da tarefa de pipeline. Predefinições para Nenhum

experiment_name
str
Necessário

Nome da experimentação em que a tarefa será criada. Se Nenhum for fornecido, a experimentação será definida como o diretório atual. Predefinições para Nenhum

jobs
dict[str, <xref:azure.ai.ml.entities._builders.BaseNode>]
Necessário

Nome do nó do componente do pipeline para objeto de componente. Predefinições para Nenhum

settings
PipelineJobSettings
Necessário

Definição da tarefa de pipeline. Predefinições para Nenhum

identity
Union[ ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration
Necessário

Identidade que a tarefa de preparação utilizará durante a execução na computação. Predefinições para Nenhum

Exemplos

Mostra como criar um pipeline com esta classe.


   from azure.ai.ml.entities import PipelineJob, PipelineJobSettings

   pipeline_job = PipelineJob(
       description="test pipeline job",
       tags={},
       display_name="test display name",
       experiment_name="pipeline_job_samples",
       properties={},
       settings=PipelineJobSettings(force_rerun=True, default_compute="cpu-cluster"),
       jobs={"component1": component_func(component_in_number=1.0, component_in_path=uri_file_input)},
   )
   ml_client.jobs.create_or_update(pipeline_job)

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 para o 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 para passar para o serializador YAML.

Exceções

Gerado se dest é um caminho de ficheiro e o ficheiro já existe.

Gerado se o 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

id

O ID do recurso.

Devoluções

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

Tipo de retorno

inputs

Entradas da tarefa de pipeline.

Devoluções

Entradas da tarefa de pipeline.

Tipo de retorno

jobs

Tarefas de retorno da tarefa de pipeline.

Devoluções

Tarefas da tarefa de pipeline.

Tipo de retorno

log_files

Ficheiros de saída da tarefa.

Devoluções

O dicionário de nomes de registo e URLs.

Tipo de retorno

outputs

Saídas da tarefa de pipeline.

Devoluções

Saídas da tarefa de pipeline.

Tipo de retorno

settings

Definições da tarefa de pipeline.

Devoluções

Definições da tarefa de pipeline.

Tipo de retorno

status

O estado da tarefa.

Os valores comuns devolvidos incluem "Running", "Completed" e "Failed". 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 tarefas.

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

    • Compilação de imagens 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 de utilizador e a execução

    fases de pós-processamento.

  • Falha - A execução falhou. Normalmente, a propriedade Erro 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

studio_url

Ponto final do Azure ML Studio.

Devoluções

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

Tipo de retorno

type

O tipo de tarefa.

Devoluções

O tipo de tarefa.

Tipo de retorno