Compartilhar via

StepRun Classe

  • Referência

Uma execução de uma etapa em um Pipeline.

Essa classe pode ser usada para gerenciar, verificar o status e recuperar detalhes da execução depois que a execução do pipeline pai for enviada e o pipeline tiver enviado a execução da etapa.

Inicialize um StepRun.

Herança
Run
StepRun

Construtor

StepRun(experiment, step_run_id, pipeline_run_id, node_id, _service_endpoint=None, _is_reused=False, _current_node_id=None, _reused_run_id=None, _reused_node_id=None, _reused_pipeline_run_id=None, **kwargs)

Parâmetros

Nome Description
experiment
Obrigatório
Experiment

O objeto de experimento da execução da etapa.
step_run_id
Obrigatório
str

A ID de execução da execução da etapa.
pipeline_run_id
Obrigatório
str

A ID de execução da execução do pipeline pai.
node_id
Obrigatório
str

A ID do nó no gráfico que representa essa etapa.
_service_endpoint
str

O ponto de extremidade ao qual se conectar.

Valor padrão: None
_is_reused
bool

Indica se esta execução é uma execução anterior reutilizada.

Valor padrão: False
_current_node_id
str

Para um nó reutilizado, a ID do nó no gráfico atual.

Valor padrão: None
_reused_run_id
str

A ID da execução reutilizada.

Valor padrão: None
_reused_node_id
str

A ID do nó reutilizado.

Valor padrão: None
_reused_pipeline_run_id
str

A ID do pipeline reutilizado.

Valor padrão: None
experiment
Obrigatório
Experiment

O objeto de experimento da execução da etapa.
step_run_id
Obrigatório
str

A ID de execução da execução da etapa.
pipeline_run_id
Obrigatório
str

A ID de execução da execução do pipeline pai.
node_id
Obrigatório
str

A ID do nó no gráfico que representa essa etapa.
_service_endpoint
Obrigatório
str

O ponto de extremidade ao qual se conectar.
_is_reused
Obrigatório
bool

Indica se esta execução é uma execução anterior reutilizada.
_current_node_id
Obrigatório
str

Para um nó reutilizado, a ID do nó no gráfico atual.
_reused_run_id
Obrigatório
_reused_node_id
Obrigatório
str
_reused_pipeline_run_id
Obrigatório
str

Comentários

Uma StepRun é criada como uma execução filho de uma PipelineRun enviada. Busque todas as StepRuns em uma 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>")
   step_runs = pipeline_run.get_steps()

Use get_details_with_logs para buscar os detalhes de execução e os logs criados pela execução.

StepRun também pode ser usado para baixar as saídas de uma execução. Use get_outputs para recuperar um dicionário das saídas da etapa ou use get_output para recuperar o único objeto StepRunOutput da saída com o nome fornecido. Você também pode usar get_output_data para buscar a PortDataReference da saída da etapa especificada diretamente.

Um exemplo de download de uma saída de etapa é o seguinte:


   from azureml.pipeline.core import PipelineRun, StepRun, PortDataReference

   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")
   step_run = pipeline_run.find_step_run("<step_name>")[0]
   port_data_reference = step_run.get_output_data("<output_name>")
   port_data_reference.download(local_path="path")

Métodos

child_run

Execução do filho para execução da etapa. Este método não é implementado para StepRun.
complete

Concluir para execução de etapas. Este método não é implementado para StepRun.
fail

Falha na execução da etapa. Este método não é implementado para StepRun.
get_details_with_logs

Retornar os detalhes de status da execução com conteúdo do arquivo de log.
get_job_log

Despejar o log de trabalho atual para a execução da etapa.
get_output

Obter a saída do nó com o nome fornecido.
get_output_data

Obter os dados de saída de uma determinada saída.
get_outputs

Obter as saídas da etapa.
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_stderr_log

Despejar o log stderr atual para a execução da etapa.
get_stdout_log

Despejar o log stdout atual para a execução da etapa.
wait_for_completion

Aguardar a conclusão da execução desta etapa.

Retorna o status após a espera.

child_run

Execução do filho para execução da etapa. Este método não é implementado para StepRun.

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

Parâmetros

Nome Description
name
str

Nome opcional para o elemento filho

Valor padrão: None
run_id
str

Run_id opcional para o filho, caso contrário, usa o padrão

Valor padrão: None
outputs
str

Diretório de saídas opcionais para rastrear o elemento filho

Valor padrão: None

Retornos

Tipo Description
Run

A execução do filho

Exceções

Tipo Description
NotImplementedError

complete

Concluir para execução de etapas. Este método não é implementado para StepRun.

complete()

Exceções

Tipo Description
NotImplementedError

fail

Falha na execução da etapa. Este método não é implementado para StepRun.

fail()

Exceções

Tipo Description
NotImplementedError

get_details_with_logs

Retornar os detalhes de status da execução com conteúdo do arquivo de log.

get_details_with_logs()

Retornos

Tipo Description
dict

Retorna o status da execução com o conteúdo do arquivo de log

Exceções

Tipo Description
NotImplementedError

get_job_log

Despejar o log de trabalho atual para a execução da etapa.

get_job_log()

Retornos

Tipo Description
str

A cadeia de caracteres de log.

Exceções

Tipo Description
NotImplementedError

get_output

Obter a saída do nó com o nome fornecido.

get_output(name)

Parâmetros

Nome Description
name
Obrigatório
str

Nome da saída.

Retornos

Tipo Description
StepRunOutput

O StepRunOutput com o nome fornecido.

Exceções

Tipo Description
NotImplementedError

get_output_data

Obter os dados de saída de uma determinada saída.

get_output_data(name)

Parâmetros

Nome Description
name
Obrigatório
str

Nome da saída.

Retornos

Tipo Description
PortDataReference

O PortDataReference que representa os dados de saída da etapa.

Exceções

Tipo Description
NotImplementedError

get_outputs

Obter as saídas da etapa.

get_outputs()

Retornos

Tipo Description
dict

Um dicionário de StepRunOutputs com o nome de saída como a chave.

Exceções

Tipo Description
NotImplementedError

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

Exceções

Tipo Description
NotImplementedError

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

  • Na Fila – o trabalho está na fila.

  • 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_stderr_log

Despejar o log stderr atual para a execução da etapa.

get_stderr_log()

Retornos

Tipo Description
str

A cadeia de caracteres de log.

Exceções

Tipo Description
NotImplementedError

get_stdout_log

Despejar o log stdout atual para a execução da etapa.

get_stdout_log()

Retornos

Tipo Description
str

A cadeia de caracteres de log.

Exceções

Tipo Description
NotImplementedError

wait_for_completion

Aguardar a conclusão da execução desta etapa.

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

show_output=True mostra o status de execução de pipeline em sys.stdout.

Valor padrão: True
timeout_seconds
int

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.

Exceções

Tipo Description
NotImplementedError

Atributos

pipeline_run_id

Retornar a ID da execução de pipeline correspondente à execução desta etapa.

Retornos

Tipo Description
str

A ID do PipelineRun.