StepRun Classe

  • Referência

Uma execução de um passo num Pipeline.

Esta classe pode ser utilizada para gerir, verificar o estado e obter os detalhes da execução assim que a execução do pipeline principal for submetida e o pipeline tiver submetido a execução do passo.

Inicializar uma 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

Name Description
experiment
Necessário
Experiment

O objeto de experimentação da execução do passo.
step_run_id
Necessário
str

O ID de execução da execução do passo.
pipeline_run_id
Necessário
str

O ID de execução da execução do pipeline principal.
node_id
Necessário
str

O ID do nó no gráfico que representa este passo.
_service_endpoint
str

O ponto final ao qual ligar.

Default value: None
_is_reused
bool

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

Default value: False
_current_node_id
str

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

Default value: None
_reused_run_id
str

O ID de execução reutilizado.

Default value: None
_reused_node_id
str

O ID do nó reutilizado.

Default value: None
_reused_pipeline_run_id
str

O ID do pipeline reutilizado.

Default value: None
experiment
Necessário
Experiment

O objeto de experimentação da execução do passo.
step_run_id
Necessário
str

O ID de execução da execução do passo.
pipeline_run_id
Necessário
str

O ID de execução da execução do pipeline principal.
node_id
Necessário
str

O ID do nó no gráfico que representa este passo.
_service_endpoint
Necessário
str

O ponto final ao qual ligar.
_is_reused
Necessário
bool

Indica se esta execução é uma execução anterior reutilizada.
_current_node_id
Necessário
str

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

Observações

Uma StepRun é criada como uma execução subordinada de um submetido PipelineRun. Obtenha todas as StepRuns num 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>")
   step_runs = pipeline_run.get_steps()

Utilize get_details_with_logs para obter os detalhes de execução e os registos criados pela execução.

StepRun também pode ser utilizado para transferir as saídas de uma execução. Utilize get_outputs para obter um ditado das saídas dos passos ou utilize get_output para obter o objeto único StepRunOutput para a saída com o nome fornecido. Também pode utilizar get_output_data para obter o PortDataReference resultado do passo especificado diretamente.

Um exemplo de transferência de uma saída de passo é 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 subordinada para execução de passos. Este método não está implementado para StepRun.
complete

Concluído para a execução do passo. Este método não está implementado para StepRun.
fail

Falha na execução do passo. Este método não está implementado para StepRun.
get_details_with_logs

Devolva os detalhes de estado da execução com o conteúdo do ficheiro de registo.
get_job_log

Despeje o registo de tarefas atual para a execução do passo.
get_output

Obtenha o resultado do nó com o nome especificado.
get_output_data

Obtenha os dados de saída de um determinado resultado.
get_outputs

Obtenha as saídas dos passos.
get_status

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

Os valores comuns devolvidos incluem "Em Execução", "Concluído" e "Com Falhas".
get_stderr_log

Despeje o registo stderr atual para a execução do passo.
get_stdout_log

Despeje o registo stdout atual para a execução do passo.
wait_for_completion

Aguarde pela conclusão desta execução de passo.

Devolve o estado após a espera.

child_run

Execução subordinada para execução de passos. Este método não está implementado para StepRun.

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

Opcional run_id para o menor; caso contrário, utiliza a predefinição

Default value: None
outputs
str

Diretório de saídas opcionais a monitorizar para o menor

Default value: None

Devoluções

Tipo Description
Run

A execução subordinada

Exceções

Tipo Description
NotImplementedError

complete

Concluído para a execução do passo. Este método não está implementado para StepRun.

complete()

Exceções

Tipo Description
NotImplementedError

fail

Falha na execução do passo. Este método não está implementado para StepRun.

fail()

Exceções

Tipo Description
NotImplementedError

get_details_with_logs

Devolva os detalhes de estado da execução com o conteúdo do ficheiro de registo.

get_details_with_logs()

Devoluções

Tipo Description
dict

Devolve o estado da execução com o conteúdo do ficheiro de registo

Exceções

Tipo Description
NotImplementedError

get_job_log

Despeje o registo de tarefas atual para a execução do passo.

get_job_log()

Devoluções

Tipo Description
str

A cadeia de registo.

Exceções

Tipo Description
NotImplementedError

get_output

Obtenha o resultado do nó com o nome especificado.

get_output(name)

Parâmetros

Name Description
name
Necessário
str

Nome da saída.

Devoluções

Tipo Description
StepRunOutput

O StepRunOutput com o nome especificado.

Exceções

Tipo Description
NotImplementedError

get_output_data

Obtenha os dados de saída de um determinado resultado.

get_output_data(name)

Parâmetros

Name Description
name
Necessário
str

Nome da saída.

Devoluções

Tipo Description
PortDataReference

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

Exceções

Tipo Description
NotImplementedError

get_outputs

Obtenha as saídas dos passos.

get_outputs()

Devoluções

Tipo Description
dict

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

Exceções

Tipo Description
NotImplementedError

get_status

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

Os valores comuns devolvidos incluem "Em Execução", "Concluído" e "Com Falhas".

get_status()

Devoluções

Tipo Description
str

O estado mais recente como uma cadeia

Exceções

Tipo Description
NotImplementedError

Observações

  • NotStarted - Este é um estado temporário em que os objetos Executar do lado do cliente estão antes da submissão da cloud

  • Em fila – a tarefa está em fila de espera.

  • Em execução – a tarefa começou a ser executada no destino de computação.

  • Falha – a execução falhou. Normalmente, a propriedade Error 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_stderr_log

Despeje o registo stderr atual para a execução do passo.

get_stderr_log()

Devoluções

Tipo Description
str

A cadeia de registo.

Exceções

Tipo Description
NotImplementedError

get_stdout_log

Despeje o registo stdout atual para a execução do passo.

get_stdout_log()

Devoluções

Tipo Description
str

A cadeia de registo.

Exceções

Tipo Description
NotImplementedError

wait_for_completion

Aguarde pela conclusão desta execução de passo.

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

show_output=Verdadeiro mostra o estado da execução do pipeline em sys.stdout.

Default value: True
timeout_seconds
int

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.

Exceções

Tipo Description
NotImplementedError

Atributos

pipeline_run_id

Devolver o ID da execução do pipeline correspondente a esta execução de passo.

Devoluções

Tipo Description
str

O ID pipelineRun.