StepRun Classe
Uma execução de uma etapa em um Pipeline.
Essa classe pode ser usada para gerenciar, verificar o status e recuperar detalhes de execução depois que a execução do pipeline pai for enviada e o pipeline tiver enviado a execução da etapa.
Inicializar um 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
|
O objeto de experimento da execução da etapa. |
|
step_run_id
Obrigatório
|
A ID de execução da execução da etapa. |
|
pipeline_run_id
Obrigatório
|
A ID de execução da execução do pipeline pai. |
|
node_id
Obrigatório
|
A ID do nó no grafo que representa esta etapa. |
|
_service_endpoint
|
O ponto de extremidade ao qual se conectar. Valor padrão: None
|
|
_is_reused
|
Indica se essa execução é uma execução anterior reutilizado. Valor padrão: False
|
|
_current_node_id
|
Para um nó reutilizado, a ID do nó no grafo atual. Valor padrão: None
|
|
_reused_run_id
|
A ID de execução reutilizado. Valor padrão: None
|
|
_reused_node_id
|
A ID do nó reutilizado. Valor padrão: None
|
|
_reused_pipeline_run_id
|
A ID do pipeline reutilizado. Valor padrão: None
|
|
experiment
Obrigatório
|
O objeto de experimento da execução da etapa. |
|
step_run_id
Obrigatório
|
A ID de execução da execução da etapa. |
|
pipeline_run_id
Obrigatório
|
A ID de execução da execução do pipeline pai. |
|
node_id
Obrigatório
|
A ID do nó no grafo que representa esta etapa. |
|
_service_endpoint
Obrigatório
|
O ponto de extremidade ao qual se conectar. |
|
_is_reused
Obrigatório
|
Indica se essa execução é uma execução anterior reutilizado. |
|
_current_node_id
Obrigatório
|
Para um nó reutilizado, a ID do nó no grafo atual. |
|
_reused_run_id
Obrigatório
|
|
|
_reused_node_id
Obrigatório
|
|
|
_reused_pipeline_run_id
Obrigatório
|
|
Comentários
Um StepRun é criado como uma execução filho de um enviado PipelineRun. Busque todas as StepRuns em um 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 ditado das saídas da etapa ou use get_output para recuperar o único StepRunOutput objeto para a saída com o nome fornecido. Você também pode usar get_output_data para buscar a PortDataReference saída da etapa especificada diretamente.
Um exemplo de como baixar 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 filho para execução de etapa. Esse método não é implementado para StepRun. |
| complete |
Concluir a execução da etapa. Esse método não é implementado para StepRun. |
| fail |
Falha na execução da etapa. Esse método não é implementado para StepRun. |
| get_details_with_logs |
Retorne os detalhes de status da execução com o conteúdo do arquivo de log. |
| get_job_log |
Despejo do log de trabalho atual para a execução da etapa. |
| get_output |
Obtenha a saída do nó com o nome fornecido. |
| get_output_data |
Obtenha os dados de saída de uma determinada saída. |
| get_outputs |
Obtenha as saídas da etapa. |
| 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_stderr_log |
Despejo do log de stderr atual para a execução da etapa. |
| get_stdout_log |
Despejo do log stdout atual para a execução da etapa. |
| wait_for_completion |
Aguarde a conclusão desta execução da etapa. Retorna o status após a espera. |
child_run
Execução filho para execução de etapa. Esse método não é implementado para StepRun.
child_run(name=None, run_id=None, outputs=None)
Parâmetros
| Nome | Description |
|---|---|
|
name
|
Nome opcional para o filho Valor padrão: None
|
|
run_id
|
O run_id opcional para o filho, caso contrário, usa o padrão Valor padrão: None
|
|
outputs
|
Diretório de saídas opcionais a ser rastreado para o filho Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
A execução filho |
Exceções
| Tipo | Description |
|---|---|
complete
Concluir a execução da etapa. Esse método não é implementado para StepRun.
complete()
Exceções
| Tipo | Description |
|---|---|
fail
Falha na execução da etapa. Esse método não é implementado para StepRun.
fail()
Exceções
| Tipo | Description |
|---|---|
get_details_with_logs
Retorne os detalhes de status da execução com o conteúdo do arquivo de log.
get_details_with_logs()
Retornos
| Tipo | Description |
|---|---|
|
Retorna o status da execução com o conteúdo do arquivo de log |
get_job_log
Despejo do log de trabalho atual para a execução da etapa.
get_job_log()
Retornos
| Tipo | Description |
|---|---|
|
A cadeia de caracteres de log. |
get_output
Obtenha a saída do nó com o nome fornecido.
get_output(name)
Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
Nome da saída. |
Retornos
| Tipo | Description |
|---|---|
|
O StepRunOutput com o nome fornecido. |
get_output_data
Obtenha os dados de saída de uma determinada saída.
get_output_data(name)
Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
Nome da saída. |
Retornos
| Tipo | Description |
|---|---|
|
O PortDataReference que representa os dados de saída da etapa. |
get_outputs
Obtenha as saídas da etapa.
get_outputs()
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário de StepRunOutputs com o nome de saída como a chave. |
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 |
|---|---|
|
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
Enfileirado – 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 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_stderr_log
Despejo do log de stderr atual para a execução da etapa.
get_stderr_log()
Retornos
| Tipo | Description |
|---|---|
|
A cadeia de caracteres de log. |
get_stdout_log
Despejo do log stdout atual para a execução da etapa.
get_stdout_log()
Retornos
| Tipo | Description |
|---|---|
|
A cadeia de caracteres de log. |
wait_for_completion
Aguarde a conclusão desta execução da 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
|
show_output=True mostra o status de execução do pipeline em sys.stdout. Valor padrão: True
|
|
timeout_seconds
|
Número de segundos para aguardar antes do tempo limite. Valor padrão: 9223372036854775807
|
|
raise_on_error
|
Indica se um erro será gerado quando a execução estiver em um estado com falha Valor padrão: True
|
Retornos
| Tipo | Description |
|---|---|
|
O status final. |
Atributos
pipeline_run_id
Retorne a ID da execução do pipeline correspondente a esta execução de etapa.
Retornos
| Tipo | Description |
|---|---|
|
A ID do PipelineRun. |