PipelineRun Classe

Representa uma corrida Pipeline de.

Esta classe pode ser usada para gerir, verificar o estado e recuperar detalhes de execução uma vez que uma corrida de gasoduto é submetida. Utilize get_steps para recuperar os StepRun objetos criados pelo gasoduto. Outras utilizações incluem a recuperação do Graph objeto associado à execução do gasoduto, a obtenção do estado do gasoduto e a espera da conclusão do curso.

Herança
PipelineRun

Construtor

PipelineRun(experiment, run_id, _service_endpoint=None)

Parâmetros

experiment
Experiment

O objeto de experiência associado ao gasoduto.

run_id
<xref:str>

A identificação do oleoduto.

_service_endpoint
<xref:str>

O ponto final a que nos ligarmos.

Observações

Um objeto PipelineRun é devolvido ao enviar um Pipeline através do submit . método de Experiment um . 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 instantâneo com a execução submetida Experiment e o PipelineRun ID 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 a utilização do PipelineRun:

  • wait_for_completion para monitorizar o estado de execução e os registos de execução de fluxo opcional.

  • get_status para obter o estado de execução.

  • cancel para cancelar um PipelineRun em curso.

  • get_steps para listar os StepRuns gerados. Um PipelineRun gera um StepRun para cada passo no Pipeline.

Métodos

cancel

Cancele a corrida em curso.

child_run

Crie uma corrida de crianças para o curso do gasoduto. Este método não é implementado para PipelineRun.

complete

Marque o curso do oleoduto como completo. Este método não é implementado para PipelineRun.

Este método não é suportado para gasodutos; o estado de conclusão/falha é gerido pelo backend Azure ML.

fail

Marque o oleoduto como falhou. Este método não é implementado para PipelineRun.

Este método não é suportado para gasodutos; o estado de conclusão/falha é gerido pelo backend Azure ML.

find_step_run

Encontre um passo na calha pelo nome.

get

Pegue uma corrida de gasoduto com base numa identificação de execução.

get_graph

Faça o gráfico do oleoduto funcionar.

get_pipeline_output

Obtenha a PortDataReference para a saída do gasoduto.

get_pipeline_runs

Buscar os gasodutos que foram gerados a partir de um oleoduto publicado.

get_status

Pegue o último estado do gasoduto do serviço.

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

get_steps

Faça o passo para todos os passos de gasoduto que tenham concluído ou começado a funcionar.

get_tags

Pegue o conjunto de etiquetas para a corrida.

publish_pipeline

Publique um oleoduto e disponibilize-o para reensar.

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

O gasoduto original associado à tubagem é utilizado como base para o gasoduto publicado.

save

Guarde o gasoduto YAML num ficheiro.

wait_for_completion

Aguarde a conclusão deste oleoduto.

Devolve o estado após a espera.

cancel

Cancele a corrida em curso.

cancel()

child_run

Crie uma corrida de crianças para o curso do gasoduto. Este método não é implementado para PipelineRun.

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

Parâmetros

name
<xref:str>
valor predefinido: None

Nome opcional para a criança.

run_id
<xref:str>
valor predefinido: None

Identificação de execução opcional para a criança, caso contrário utiliza o predefinido.

outputs
<xref:str>
valor predefinido: None

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

Devoluções

A criança fugiu.

Tipo de retorno

Run

complete

Marque o curso do oleoduto como completo. Este método não é implementado para PipelineRun.

Este método não é suportado para gasodutos; o estado de conclusão/falha é gerido pelo backend Azure ML.

complete()

fail

Marque o oleoduto como falhou. Este método não é implementado para PipelineRun.

Este método não é suportado para gasodutos; o estado de conclusão/falha é gerido pelo backend Azure ML.

fail()

find_step_run

Encontre um passo na calha pelo nome.

find_step_run(name)

Parâmetros

name
<xref:str>

O nome do passo a encontrar.

Devoluções

Lista de StepRun objetos com o nome fornecido.

Tipo de retorno

get

Pegue uma corrida de gasoduto com base numa identificação de execução.

get(workspace, run_id, _service_endpoint=None)

Parâmetros

workspace
Workspace

O espaço de trabalho associado ao oleoduto.

run_id
<xref:str>

A identificação do oleoduto.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final a que nos ligarmos.

Devoluções

O PipelineRun objeto.

Tipo de retorno

get_graph

Faça o gráfico do oleoduto funcionar.

get_graph()

Devoluções

O gráfico.

Tipo de retorno

get_pipeline_output

Obtenha a PortDataReference para a saída do gasoduto.

get_pipeline_output(pipeline_output_name)

Parâmetros

pipeline_output_name
<xref:str>

O nome da saída do oleoduto para obter.

Devoluções

A PortDataReference que representa os dados de saída do gasoduto.

Tipo de retorno

get_pipeline_runs

Buscar os gasodutos que foram gerados a partir de um oleoduto publicado.

get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parâmetros

workspace
Workspace

O espaço de trabalho associado ao oleoduto.

pipeline_id
<xref:str>

A identificação do oleoduto publicado.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final a que nos ligarmos.

Devoluções

Uma lista de PipelineRun objetos.

Tipo de retorno

get_status

Pegue o último estado do gasoduto do serviço.

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

get_status()

Devoluções

O último estatuto como corda.

Tipo de retorno

<xref:str>

Observações

  • NotStarted - Este é um estado temporário lado cliente Executar objetos estão dentro antes da submissão da nuvem

  • Running - O trabalho começou a correr no alvo do cálculo.

  • Falhou - A corrida falhou. Normalmente, a propriedade Error on a run irá fornecer detalhes sobre o porquê.

  • Terminado - A execução concluída com sucesso.

  • Cancelado - Após pedido de cancelamento, a corrida foi agora 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

Faça o passo para todos os passos de gasoduto que tenham concluído ou começado a funcionar.

get_steps()

Devoluções

Uma lista de StepRun objetos.

Tipo de retorno

get_tags

Pegue o conjunto de etiquetas para a corrida.

get_tags()

Devoluções

O dicionário de etiquetas para a corrida.

Tipo de retorno

<xref:dict>

publish_pipeline

Publique um oleoduto e disponibilize-o para reensar.

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

O gasoduto original associado à tubagem é utilizado como base para o gasoduto publicado.

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

Parâmetros

name
<xref:str>

O nome do oleoduto publicado.

description
<xref:str>

A descrição do oleoduto publicado.

version
<xref:str>

A versão do oleoduto publicado.

continue_on_step_failure
<xref:bool>
valor predefinido: None

Se continuar a execução de outros passos no PipelineRun se um passo falhar. O padrão é falso.

kwargs
<xref:dict>

Argumentos de palavras-chave personalizadas, reservados para o desenvolvimento futuro

Devoluções

Criado oleoduto publicado.

Tipo de retorno

save

Guarde o gasoduto YAML num ficheiro.

save(path=None)

Parâmetros

path
<xref:str>
valor predefinido: None

O caminho para salvar a YAML para. Se o caminho for um diretório, o ficheiro YAML do gasoduto é guardado no < caminho > /pipeline.yml. Se o caminho não for nenhum, o diretório atual é usado.

Tipo de retorno

<xref:None>

wait_for_completion

Aguarde a conclusão deste oleoduto.

Devolve o estado após a espera.

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

Parâmetros

show_output
<xref:bool>
valor predefinido: True

Indica se deve mostrar o estado de funcionação do gasoduto em sys.stdout.

timeout_seconds
<xref:int>
valor predefinido: 9223372036854775807

O número de segundos para esperar antes do tempo de saída.

raise_on_error
<xref:bool>
valor predefinido: True

Indica se deve levantar um erro quando a execução está num estado falhado.

Devoluções

O estado final.

Tipo de retorno

<xref:str>