Partilhar via

PipelineRun Classe

Representa uma execução de um Pipelinearquivo .

Essa classe pode ser usada para gerenciar, verificar o status e recuperar detalhes de execução assim que uma execução de pipeline é enviada. Use get_steps para recuperar os StepRun objetos que são 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.

Inicialize uma execução de pipeline.

Construtor

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

Parâmetros

Name Description
experiment
Necessário
Experiment

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

A ID de execução do pipeline é executada.
_service_endpoint
str

O ponto de extremidade ao qual se conectar.

Default value: None
experiment
Necessário
Experiment

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

A ID de execução do pipeline é executada.
_service_endpoint
Necessário
str

O ponto de extremidade ao qual se conectar.

Observações

Um objeto PipelineRun é retornado ao enviar um Pipeline através do submitarquivo . 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 para a Experiment qual a execução foi 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 PipelineRun use:

  • 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 os StepRuns gerados. Um PipelineRun gera um StepRun para cada etapa do Pipeline.

Métodos

cancel

Cancele a execução em curso.
child_run

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

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

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

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

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

Encontre uma etapa executada no pipeline pelo nome.
get

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

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

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

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

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

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

Obtenha a execução da etapa para todas as etapas do pipeline que foram concluídas ou começaram a ser executadas.
get_tags

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

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

Você pode obter o ponto de extremidade do pipeline do objeto PublishedPipeline retornado por essa função. Com o ponto de extremidade de 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 pipeline YAML em um arquivo.
wait_for_completion

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

Retorna o status após a espera.

cancel

Cancele a execução em curso.

cancel()

child_run

Crie 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

Name Description
name
str

Nome opcional para a criança.

Default value: None
run_id
str

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

Default value: None
outputs
str

Diretório de saídas opcional para rastrear para a criança.

Default value: None

Devoluções

Tipo Description
Run

A criança corre.

Exceções

Tipo Description
NotImplementedError

complete

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

Este método não é suportado 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. Este método não é implementado para PipelineRun.

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

fail()

Exceções

Tipo Description
NotImplementedError

find_step_run

Encontre uma etapa executada no pipeline pelo nome.

find_step_run(name)

Parâmetros

Name Description
name
Necessário
str

O nome da etapa a ser localizada.

Devoluções

Tipo Description
list

Lista de StepRun objetos com o nome fornecido.

get

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

static get(workspace, run_id, _service_endpoint=None)

Parâmetros

Name Description
workspace
Necessário
Workspace

O espaço de trabalho associado ao pipeline.
run_id
Necessário
str

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

O ponto de extremidade ao qual se conectar.

Default value: None

Devoluções

Tipo Description
PipelineRun

O objeto PipelineRun.

get_graph

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

get_graph()

Devoluções

Tipo Description
Graph

O gráfico.

get_pipeline_output

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

get_pipeline_output(pipeline_output_name)

Parâmetros

Name Description
pipeline_output_name
Necessário
str

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

Devoluções

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 a partir de um pipeline publicado.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parâmetros

Name Description
workspace
Necessário
Workspace

O espaço de trabalho associado ao pipeline.
pipeline_id
Necessário
str

A ID do pipeline publicado.
_service_endpoint
str

O ponto de extremidade ao qual se conectar.

Default value: None

Devoluções

Tipo Description
list

Uma lista de PipelineRun objetos.

get_status

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

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

get_status()

Devoluções

Tipo Description
str

O status mais recente como uma cadeia de caracteres.

Observações

  • NotStarted - Este é um estado temporário em que os objetos Run do lado do cliente estão antes do envio na 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 o pedido de cancelamento, a corrida 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

Obtenha a execução da etapa para todas as etapas do pipeline que foram concluídas ou começaram a ser executadas.

get_steps()

Devoluções

Tipo Description
list

Uma lista de StepRun objetos.

get_tags

Obtenha o conjunto de tags para a execução.

get_tags()

Devoluções

Tipo Description
dict

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

publish_pipeline

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

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

Name Description
name
Necessário
str

O nome do pipeline publicado.
description
Necessário
str

A descrição do pipeline publicado.
version
Necessário
str

A versão do pipeline publicado.
continue_on_step_failure
bool

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

Default value: None
kwargs
Necessário
dict

Argumentos de palavras-chave personalizados, reservados para desenvolvimento futuro

Devoluções

Tipo Description
PublishedPipeline

Criação de pipeline publicado.

save

Salve o pipeline YAML em um arquivo.

save(path=None)

Parâmetros

Name Description
path
str

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

Default value: None

Devoluções

Tipo Description
None

wait_for_completion

Aguarde 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

Name Description
show_output
bool

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

Default value: True
timeout_seconds
int

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

Default value: 9223372036854775807
raise_on_error
bool

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

Default value: True

Devoluções

Tipo Description
str

O estatuto final.