PipelineRun Classe

Referência

Representa uma execução de um Pipeline.

Esta classe pode ser utilizada para gerir, verificar o estado e obter os detalhes da execução assim que uma execução de pipeline for submetida. Utilize get_steps para obter os StepRun objetos que são criados pela execução do pipeline. Outras utilizações incluem obter o Graph objeto associado à execução do pipeline, obter o estado 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

Name	Description
experiment Necessário	Experiment O objeto de experimentação associado à execução do pipeline.
run_id Necessário	str O ID de execução da execução do pipeline.
_service_endpoint	str O ponto final ao qual se ligar. Default value: None
experiment Necessário	Experiment O objeto de experimentação associado à execução do pipeline.
run_id Necessário	str O ID de execução da execução do pipeline.
_service_endpoint Necessário	str O ponto final ao qual se ligar.

Observações

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

Um PipelineRun também pode ser instanciado com a execução Experiment submetida e o ID 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 PipelineRun, utilize:

wait_for_completion para monitorizar o estado da execução e, opcionalmente, transmitir em fluxo registos de execução.
get_status para obter o estado de execução.
cancel para cancelar um PipelineRun em curso.
get_steps para listar as StepRuns geradas. Um PipelineRun gera um StepRun para cada passo no Pipeline.

Métodos

cancel	Cancele a execução em curso.
child_run	Crie uma execução subordinada para a execução do pipeline. Este método não está implementado para PipelineRun.
complete	Marcar a execução do pipeline como concluída. Este método não está implementado para PipelineRun. Este método não é suportado para pipelines; o estado de conclusão/falha é gerido pelo back-end do Azure ML.
fail	Marcar a execução do pipeline como falha. Este método não está implementado para PipelineRun. Este método não é suportado para pipelines; o estado de conclusão/falha é gerido pelo back-end do Azure ML.
find_step_run	Localize uma execução de passo no pipeline por nome.
get	Obtenha uma execução de pipeline com base num ID de execução.
get_graph	Obtenha o gráfico da execução do pipeline.
get_pipeline_output	Obtenha o PortDataReference para o resultado do pipeline especificado.
get_pipeline_runs	Obtenha as execuções de pipeline que foram geradas a partir de um pipeline publicado.
get_status	Obtenha o estado mais recente da execução do pipeline a partir do serviço. Os valores comuns devolvidos incluem "Running", "Finished" e "Failed".
get_steps	Obtenha as execuções de passos para todos os passos do pipeline que tenham sido concluídos ou iniciados em execução.
get_tags	Obtenha o conjunto de etiquetas para a execução.
publish_pipeline	Publique um pipeline e disponibilize-o para nova execução. Pode obter o ponto final do pipeline a partir do objeto PublishedPipeline devolvido por esta função. Com o ponto final do pipeline, pode invocar o pipeline a partir de aplicações externas através de chamadas REST. Para obter informações sobre como autenticar ao chamar pontos finais REST, consulte https://aka.ms/pl-restep-auth. O pipeline original associado à execução do pipeline é utilizado como base para o pipeline publicado.
save	Guarde o YAML do pipeline num ficheiro.
wait_for_completion	Aguarde pela conclusão desta execução do pipeline. Devolve o estado após a espera.

cancel

Cancele a execução em curso.

cancel()

child_run

Crie uma execução subordinada para a execução do pipeline. Este método não está implementado para PipelineRun.

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

Parâmetros

Name	Description
name	str Nome opcional para o menor. Default value: None
run_id	str ID de execução opcional para o menor, caso contrário, utiliza a predefinição. Default value: None
outputs	str Diretório de saídas opcionais para controlar o menor. Default value: None

Devoluções

Tipo	Description
Run	A criança corre.

Exceções

Tipo	Description
NotImplementedError

complete

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

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

complete()

Exceções

Tipo	Description
NotImplementedError

fail

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

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

fail()

Exceções

Tipo	Description
NotImplementedError

find_step_run

Localize uma execução de passo no pipeline por nome.

find_step_run(name)

Parâmetros

Name	Description
name Necessário	str O nome do passo a localizar.

Devoluções

Tipo	Description
list	Lista de StepRun objetos com o nome fornecido.

get

Obtenha uma execução de pipeline com base num ID de execução.

static get(workspace, run_id, _service_endpoint=None)

Parâmetros

Name	Description
workspace Necessário	Workspace A área de trabalho associada ao pipeline.
run_id Necessário	str O ID da execução do pipeline.
_service_endpoint	str O ponto final ao qual se ligar. Default value: None

Devoluções

Tipo	Description
PipelineRun	O PipelineRun objeto.

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 o resultado do pipeline especificado.

get_pipeline_output(pipeline_output_name)

Parâmetros

Name	Description
pipeline_output_name Necessário	str O nome da saída do pipeline a obter.

Devoluções

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

get_pipeline_runs

Obtenha 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 A área de trabalho associada ao pipeline.
pipeline_id Necessário	str O ID do pipeline publicado.
_service_endpoint	str O ponto final ao qual se ligar. Default value: None

Devoluções

Tipo	Description
list	Uma lista de PipelineRun objetos.

get_status

Obtenha o estado mais recente da execução do pipeline a partir do serviço.

Os valores comuns devolvidos incluem "Running", "Finished" e "Failed".

get_status()

Devoluções

Tipo	Description
str	O estado mais recente como uma cadeia.

Observações

NotStarted - Este é um estado temporário em que os objetos Run do lado do cliente estão antes da submissão da cloud
Em execução – a tarefa começou a ser executada no destino de computação.
Falha - A execução falhou. Normalmente, a propriedade Erro numa execução irá fornecer detalhes sobre o motivo.
Concluído – a execução foi concluída com êxito.
Cancelado – após o pedido 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 de passos para todos os passos do pipeline que tenham sido concluídos ou iniciados em execução.

get_steps()

Devoluções

Tipo	Description
list	Uma lista de StepRun objetos.

get_tags

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

get_tags()

Devoluções

Tipo	Description
dict	O dicionário de etiquetas para a execução.

publish_pipeline

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

Pode obter o ponto final do pipeline a partir do objeto PublishedPipeline devolvido por esta função. Com o ponto final do pipeline, pode invocar o pipeline a partir de aplicações externas através de chamadas REST. Para obter informações sobre como autenticar ao chamar pontos finais REST, consulte https://aka.ms/pl-restep-auth.

O pipeline original associado à execução do pipeline é utilizado 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 pretende continuar a execução de outros passos no PipelineRun se um passo falhar. A predefinição é Falso. Default value: None
kwargs Necessário	dict Argumentos de palavra-chave personalizados, reservados para desenvolvimento futuro

Devoluções

Tipo	Description
PublishedPipeline	Pipeline publicado criado.

save

Guarde o YAML do pipeline num ficheiro.

save(path=None)

Parâmetros

Name	Description
path	str O caminho para guardar o YAML. Se o caminho for um diretório, o ficheiro YAML do pipeline será guardado em <path>/pipeline.yml. Se o caminho não for nenhum, é utilizado o diretório atual. Default value: None

Devoluções

Tipo	Description
None

wait_for_completion

Aguarde pela conclusão desta execução do pipeline.

Devolve o estado 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 pretende mostrar o estado da execução do pipeline em sys.stdout. Default value: True
timeout_seconds	int O número de segundos a aguardar antes de exceder o tempo limite. Default value: 9223372036854775807
raise_on_error	bool Indica se deve gerar um erro quando a execução está num estado de falha. Default value: True

Devoluções

Tipo	Description
str	O estado final.

Partilhar via

PipelineRun Classe

Construtor

Parâmetros

Observações

Métodos

cancel

child_run

Parâmetros

Devoluções

Exceções

complete

Exceções

fail

Exceções

find_step_run

Parâmetros

Devoluções

get

Parâmetros

Devoluções

get_graph

Devoluções

get_pipeline_output

Parâmetros

Devoluções

get_pipeline_runs

Parâmetros

Devoluções

get_status

Devoluções

Observações

get_steps

Devoluções

get_tags

Devoluções

publish_pipeline

Parâmetros

Devoluções

save

Parâmetros

Devoluções

wait_for_completion

Parâmetros

Devoluções

Comentários

Recursos adicionais