PipelineRun Classe

  • Referência

Representa uma execução de um Pipeline.

Essa classe pode ser usada para gerenciar, verificar o status e recuperar detalhes da execução após uma execução de pipeline ser enviada. Use get_steps para recuperar os objetos StepRun criados pela execução de pipeline. Outros usos incluem recuperar o objeto Graph associado à execução do pipeline, buscar o status da execução do pipeline e aguardar a conclusão da execução.

Inicializar uma execução de pipeline.

Herança
Run
PipelineRun

Construtor

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

Parâmetros

Nome Description
experiment
Obrigatório
Experiment

O objeto de experimento associado à execução do pipeline.
run_id
Obrigatório
str

A ID da execução de pipeline.
_service_endpoint
str

O ponto de extremidade ao qual se conectar.

Valor padrão: None
experiment
Obrigatório
Experiment

O objeto de experimento associado à execução do pipeline.
run_id
Obrigatório
str

A ID da execução de pipeline.
_service_endpoint
Obrigatório
str

O ponto de extremidade ao qual se conectar.

Comentários

Um objeto PipelineRun é retornado ao enviar um Pipeline por meio do submit. método de um Experiment. Para obter mais informações sobre como criar e enviar um pipeline, consulte: https://aka.ms/pl-first-pipeline.

Um PipelineRun também pode ter a instância criada com o Experiment; a execução foi enviada e o ID do PipelineRun da seguinte forma:


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

Ao trabalhar com o PipelineRun, use:

  • wait_for_completion para monitorar o status de execução e, opcionalmente, os logs de execução de fluxo.

  • get_status para buscar o status de execução.

  • cancel para cancelar um PipelineRun em andamento.

  • get_steps para listar o StepRuns gerado. Um PipelineRun gera um StepRun para cada etapa no pipeline.

Métodos

cancel

Cancelar a execução em andamento.
child_run

Criar uma execução filho para a execução do pipeline. Este método não é implementado para PipelineRun.
complete

Marcar a execução do pipeline como concluída. Este método não é implementado para PipelineRun.

Este método não é compatível com pipelines; o status de conclusão/falha é gerenciado pelo back-end do Azure ML.
fail

Marcar a execução do pipeline como com falha. Este método não é implementado para PipelineRun.

Este método não é compatível com pipelines; o status de conclusão/falha é gerenciado pelo back-end do Azure ML.
find_step_run

Localizar uma etapa executada no pipeline por nome.
get

Buscar uma execução de pipeline com base em na ID de uma execução.
get_graph

Obter o gráfico da execução do pipeline.
get_pipeline_output

Obter o PortDataReference para a saída de pipeline fornecida.
get_pipeline_runs

Buscar as execuções de pipeline que foram geradas de um pipeline publicado.
get_status

Buscar o status mais recente da execução do pipeline do serviço.

Os valores comuns retornados incluem "Em execução", "Concluído" e "Com falha".
get_steps

Obter as execuções de todas as etapas do pipeline que foram concluídas ou iniciadas.
get_tags

Obter o conjunto de marcas para a execução.
publish_pipeline

Publicar um pipeline e disponibilizá-lo para nova execução.

Você pode obter o ponto de extremidade do pipeline do objeto PublishedPipeline retornado por esta função. Com o ponto de extremidade do pipeline, você pode invocar o pipeline de aplicativos externos usando chamadas REST. Para obter informações sobre como autenticar ao chamar pontos de extremidade REST, consulte https://aka.ms/pl-restep-auth.

O pipeline original associado à execução do pipeline é usado como base para o pipeline publicado.
save

Salvar o pipeline YAML em um arquivo.
wait_for_completion

Aguardar a conclusão desta execução de pipeline.

Retorna o status após a espera.

cancel

Cancelar a execução em andamento.

cancel()

child_run

Criar uma execução filho para a execução do pipeline. Este método não é implementado para PipelineRun.

child_run(name=None, run_id=None, outputs=None)

Parâmetros

Nome Description
name
str

Nome opcional para o filho.

Valor padrão: None
run_id
str

ID de execução opcional para o filho; caso contrário, usa o padrão.

Valor padrão: None
outputs
str

Diretório de saídas opcional para rastrear o filho.

Valor padrão: None

Retornos

Tipo Description
Run

A execução do filho.

Exceções

Tipo Description
NotImplementedError

complete

Marcar a execução do pipeline como concluída. Este método não é implementado para PipelineRun.

Este método não é compatível com pipelines; o status de conclusão/falha é gerenciado pelo back-end do Azure ML.

complete()

Exceções

Tipo Description
NotImplementedError

fail

Marcar a execução do pipeline como com falha. Este método não é implementado para PipelineRun.

Este método não é compatível com pipelines; o status de conclusão/falha é gerenciado pelo back-end do Azure ML.

fail()

Exceções

Tipo Description
NotImplementedError

find_step_run

Localizar uma etapa executada no pipeline por nome.

find_step_run(name)

Parâmetros

Nome Description
name
Obrigatório
str

O nome da etapa a ser localizada.

Retornos

Tipo Description
list

Lista de objetos StepRun com o nome fornecido.

get

Buscar uma execução de pipeline com base em na ID de uma execução.

static get(workspace, run_id, _service_endpoint=None)

Parâmetros

Nome Description
workspace
Obrigatório
Workspace

O espaço de trabalho associado ao pipeline.
run_id
Obrigatório
str

A ID da execução de pipeline.
_service_endpoint
str

O ponto de extremidade ao qual se conectar.

Valor padrão: None

Retornos

Tipo Description
PipelineRun

O objeto PipelineRun.

get_graph

Obter o gráfico da execução do pipeline.

get_graph()

Retornos

Tipo Description
Graph

O gráfico.

get_pipeline_output

Obter o PortDataReference para a saída de pipeline fornecida.

get_pipeline_output(pipeline_output_name)

Parâmetros

Nome Description
pipeline_output_name
Obrigatório
str

O nome da saída do pipeline a ser obtida.

Retornos

Tipo Description
PortDataReference

O PortDataReference que representa os dados de saída do pipeline.

get_pipeline_runs

Buscar as execuções de pipeline que foram geradas de um pipeline publicado.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parâmetros

Nome Description
workspace
Obrigatório
Workspace

O espaço de trabalho associado ao pipeline.
pipeline_id
Obrigatório
str

A ID do pipeline publicado.
_service_endpoint
str

O ponto de extremidade ao qual se conectar.

Valor padrão: None

Retornos

Tipo Description
list

Uma lista de objetos PipelineRun.

get_status

Buscar o status mais recente da execução do pipeline do serviço.

Os valores comuns retornados incluem "Em execução", "Concluído" e "Com falha".

get_status()

Retornos

Tipo Description
str

O status mais recente como uma cadeia de caracteres.

Comentários

  • Não iniciado - É um estado temporário em que os objetos de execução do lado do cliente estão dentro antes do envio para a nuvem

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

  • Falha - A execução falhou. Normalmente, a propriedade Erro em uma execução fornecerá detalhes sobre o porquê.

  • Concluído - A execução foi concluída com sucesso.

  • Cancelado - Após a solicitação de cancelamento, a execução agora foi cancelada com sucesso.


   run = experiment.submit(config)
   while run.get_status() not in ['Finished', 'Failed']: # For example purposes only, not exhaustive
       print('Run {} not in terminal state'.format(run.id))
       time.sleep(10)

get_steps

Obter as execuções de todas as etapas do pipeline que foram concluídas ou iniciadas.

get_steps()

Retornos

Tipo Description
list

Uma lista de objetos StepRun.

get_tags

Obter o conjunto de marcas para a execução.

get_tags()

Retornos

Tipo Description
dict

O dicionário de marcas para a execução.

publish_pipeline

Publicar um pipeline e disponibilizá-lo para nova execução.

Você pode obter o ponto de extremidade do pipeline do objeto PublishedPipeline retornado por esta função. Com o ponto de extremidade do pipeline, você pode invocar o pipeline de aplicativos externos usando chamadas REST. Para obter informações sobre como autenticar ao chamar pontos de extremidade REST, consulte https://aka.ms/pl-restep-auth.

O pipeline original associado à execução do pipeline é usado como base para o pipeline publicado.

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

Parâmetros

Nome Description
name
Obrigatório
str

O nome do pipeline publicado.
description
Obrigatório
str

A descrição do pipeline publicado.
version
Obrigatório
str

A versão do pipeline publicado.
continue_on_step_failure
bool

Se a execução de outras etapas no PipelineRun deverá ou não continuar se uma etapa falhar. O padrão é False.

Valor padrão: None
kwargs
Obrigatório
dict

Argumentos de palavra-chave personalizados, reservados para desenvolvimento futuro

Retornos

Tipo Description
PublishedPipeline

Pipeline publicado criado.

save

Salvar o pipeline YAML em um arquivo.

save(path=None)

Parâmetros

Nome Description
path
str

O caminho no qual salvar o YAML. Se o caminho for um diretório, o arquivo YAML do PipelineDraft será salvo em <path>/pipeline_name.yml. Se o caminho for Nenhum, será usado o diretório atual.

Valor padrão: None

Retornos

Tipo Description
None

wait_for_completion

Aguardar a conclusão desta execução de pipeline.

Retorna o status após a espera.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

Parâmetros

Nome Description
show_output
bool

Indica se o status de execução do pipeline deve ser mostrado em sys.stdout.

Valor padrão: True
timeout_seconds
int

O número de segundos a aguardar antes de esgotar o tempo limite.

Valor padrão: 9223372036854775807
raise_on_error
bool

Indica se um erro deve ser gerado quando a execução está em um estado de falha.

Valor padrão: True

Retornos

Tipo Description
str

O status final.