Compartilhar via

PipelineRun Classe

Representa uma execução de um Pipeline.

Essa classe pode ser usada para gerenciar, verificar o status e recuperar detalhes de execução depois que uma execução de pipeline é enviada. Use get_steps para recuperar os StepRun objetos criados pela execução do pipeline. Outros usos incluem recuperar o Graph objeto 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.

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 de execução da execução do 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 de execução da execução do 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 ser instanciado com a execução Experiment enviada e a ID do PipelineRun da seguinte maneira:


   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 uso do PipelineRun:

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

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

  • cancel para cancelar um PipelineRun em andamento.

  • get_steps para listar as StepRuns geradas. Um PipelineRun gera uma StepRun para cada etapa no Pipeline.

Métodos

cancel

Cancele a execução em andamento.
child_run

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

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

Esse método não tem suporte para pipelines; o status de conclusão/falha é gerenciado pelo back-end do Azure ML.
fail

Marque a execução do pipeline como falha. Esse método não é implementado para PipelineRun.

Esse método não tem suporte para pipelines; o status de conclusão/falha é gerenciado pelo back-end do Azure ML.
find_step_run

Localize uma execução de etapa no pipeline pelo nome.
get

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

Obtenha o grafo da execução do pipeline.
get_pipeline_output

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

Busque as execuções de pipeline que foram geradas a partir de um pipeline publicado.
get_status

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

Os valores comuns retornados incluem "Executando", "Concluído" e "Falha".
get_steps

Obtenha as execuções da etapa para todas as etapas de pipeline que foram concluídas ou iniciadas em execução.
get_tags

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

Publique um pipeline e disponibilize-o para execução nova.

Você pode obter o ponto de extremidade de pipeline do objeto PublishedPipeline retornado por essa 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

Salve o YAML do pipeline em um arquivo.
wait_for_completion

Aguarde a conclusão dessa execução de pipeline.

Retorna o status após a espera.

cancel

Cancele a execução em andamento.

cancel()

child_run

Crie uma execução filho para a execução do pipeline. Esse 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

A 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 opcionais a ser rastreado para o filho.

Valor padrão: None

Retornos

Tipo Description
Run

A corrida filho.

Exceções

Tipo Description
NotImplementedError

complete

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

Esse método não tem suporte para pipelines; o status de conclusão/falha é gerenciado pelo back-end do Azure ML.

complete()

Exceções

Tipo Description
NotImplementedError

fail

Marque a execução do pipeline como falha. Esse método não é implementado para PipelineRun.

Esse método não tem suporte para pipelines; o status de conclusão/falha é gerenciado pelo back-end do Azure ML.

fail()

Exceções

Tipo Description
NotImplementedError

find_step_run

Localize uma execução de etapa no pipeline pelo nome.

find_step_run(name)

Parâmetros

Nome Description
name
Obrigatório
str

O nome da etapa a ser encontrada.

Retornos

Tipo Description
list

Lista de StepRun objetos com o nome fornecido.

get

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

static get(workspace, run_id, _service_endpoint=None)

Parâmetros

Nome Description
workspace
Obrigatório
Workspace

O workspace 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

Obtenha o grafo da execução do pipeline.

get_graph()

Retornos

Tipo Description
Graph

O grafo.

get_pipeline_output

Obtenha 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 obtido.

Retornos

Tipo Description
PortDataReference

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

get_pipeline_runs

Busque as execuções de pipeline que foram geradas a partir de um pipeline publicado.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parâmetros

Nome Description
workspace
Obrigatório
Workspace

O workspace 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 PipelineRun objetos.

get_status

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

Os valores comuns retornados incluem "Executando", "Concluído" e "Falha".

get_status()

Retornos

Tipo Description
str

O status mais recente como uma cadeia de caracteres.

Comentários

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

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

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

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

  • Cancelado – Após a solicitação de cancelamento, a execução foi cancelada com êxito.


   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

Obtenha as execuções da etapa para todas as etapas de pipeline que foram concluídas ou iniciadas em execução.

get_steps()

Retornos

Tipo Description
list

Uma lista de StepRun objetos.

get_tags

Obtenha 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

Publique um pipeline e disponibilize-o para execução nova.

Você pode obter o ponto de extremidade de pipeline do objeto PublishedPipeline retornado por essa 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 deve continuar a execução de outras etapas no PipelineRun 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

Salve o YAML do pipeline em um arquivo.

save(path=None)

Parâmetros

Nome Description
path
str

O caminho para o qual salvar o YAML. Se o caminho for um diretório, o arquivo YAML do pipeline será salvo no <caminho>/pipeline.yml. Se o caminho não for nenhum, o diretório atual será usado.

Valor padrão: None

Retornos

Tipo Description
None

wait_for_completion

Aguarde a conclusão dessa 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 será gerado quando a execução estiver em um estado com falha.

Valor padrão: True

Retornos

Tipo Description
str

O status final.