StepRun Classe

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

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.

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 experimento da etapa executada.
step_run_id Necessário	str A ID de execução da etapa de execução.
pipeline_run_id Necessário	str A ID de execução do pipeline pai é executado.
node_id Necessário	str A ID do nó no gráfico que representa esta etapa.
_service_endpoint	str O ponto de extremidade ao qual se conectar. 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 experimento da etapa executada.
step_run_id Necessário	str A ID de execução da etapa de execução.
pipeline_run_id Necessário	str A ID de execução do pipeline pai é executado.
node_id Necessário	str A ID do nó no gráfico que representa esta etapa.
_service_endpoint Necessário	str O ponto de extremidade ao qual se conectar.
_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

Um StepRun é criado como uma execução filho de um arquivo PipelineRun. Buscar todos os 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 e logs de execução 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 de 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 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	Criança correr para execução de etapa. Este método não é implementado para StepRun.
complete	Conclua para execução de etapa. 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	Retorne os detalhes de status da execução com o conteúdo do arquivo de log.
get_job_log	Despeje o 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	Buscar o status mais recente da execução do pipeline no serviço. Os valores comuns retornados incluem "Em execução", "Concluído" e "Falha".
get_stderr_log	Despeje o log stderr atual para a execução da etapa.
get_stdout_log	Despeje o log stdout atual para a execução da etapa.
wait_for_completion	Aguarde a conclusão desta etapa de execução. Retorna o status após a espera.

child_run

Criança correr para execução de etapa. Este método não é implementado para StepRun.

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

Parâmetros

Name	Description
name	str Nome opcional para a criança Default value: None
run_id	str Opcional run_id para a criança, caso contrário, usa padrão Default value: None
outputs	str Diretório de saídas opcional para rastrear para o filho Default value: None

Devoluções

Tipo	Description
Run	A criança corre

Exceções

Tipo	Description
NotImplementedError

complete

Conclua para execução de etapa. 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

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

get_details_with_logs()

Devoluções

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

get_job_log

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

get_job_log()

Devoluções

Tipo	Description
str	A cadeia de caracteres de log.

get_output

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

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 próprio.

get_output_data

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

get_output_data(name)

Parâmetros

Name	Description
name Necessário	str Nome da saída.

Devoluções

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

get_outputs

Obtenha as saídas da etapa.

get_outputs()

Devoluções

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

get_status

Buscar o status mais recente da execução do pipeline no serviço.

Os valores comuns retornados incluem "Em execução", "Concluído" e "Falha".

get_status()

Devoluções

Tipo	Description
str	O status mais recente como uma cadeia de caracteres

Observações

• NotStarted - Este é um estado temporário em que os objetos Run do lado do cliente estão antes do envio na nuvem

• Em 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 Error em uma execução fornecerá detalhes sobre o motivo.

• Concluído - A execução foi concluída com êxito.

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

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

get_stderr_log()

Devoluções

Tipo	Description
str	A cadeia de caracteres de log.

get_stdout_log

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

get_stdout_log()

Devoluções

Tipo	Description
str	A cadeia de caracteres de log.

wait_for_completion

Aguarde a conclusão desta etapa de execução.

Retorna o status 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=True mostra o status de execução do pipeline em sys.stdout. Default value: True
timeout_seconds	int Número de segundos a aguardar antes do tempo limite. Default value: 9223372036854775807
raise_on_error	bool Indica se um erro deve ser gerado quando a Execução está em um estado de falha Default value: True

Devoluções

Tipo	Description
str	O estatuto final.

Atributos

pipeline_run_id

Retorne a id da execução do pipeline correspondente a esta etapa de execução.

Devoluções

Tipo	Description
str	A id PipelineRun.