StepRun Classe

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

experiment

Experiment

Necessário

O objeto de experimentação da execução do passo.

step_run_id

str

Necessário

O ID de execução da execução do passo.

pipeline_run_id

str

Necessário

O ID de execução da execução do pipeline principal.

node_id

str

Necessário

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

_service_endpoint

str

valor predefinido: None

O ponto final ao qual ligar.

_is_reused

bool

valor predefinido: False

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

_current_node_id

str

valor predefinido: None

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

_reused_run_id

str

valor predefinido: None

O ID de execução reutilizado.

_reused_node_id

str

valor predefinido: None

O ID do nó reutilizado.

_reused_pipeline_run_id

str

valor predefinido: None

O ID do pipeline reutilizado.

experiment

Experiment

Necessário

O objeto de experimentação da execução do passo.

step_run_id

str

Necessário

O ID de execução da execução do passo.

pipeline_run_id

str

Necessário

O ID de execução da execução do pipeline principal.

node_id

str

Necessário

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

_service_endpoint

str

Necessário

O ponto final ao qual ligar.

_is_reused

bool

Necessário

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

_current_node_id

str

Necessário

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

_reused_run_id

Necessário

_reused_node_id

str

Necessário

_reused_pipeline_run_id

str

Necessário

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

str

valor predefinido: None

Nome opcional para o menor

run_id

str

valor predefinido: None

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

outputs

str

valor predefinido: None

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

Devoluções

A execução subordinada

Tipo de retorno

Run

Exceções

NotImplementedError

complete

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

complete()

Exceções

NotImplementedError

fail

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

fail()

Exceções

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

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

Tipo de retorno

dict

Exceções

NotImplementedError

get_job_log

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

get_job_log()

Devoluções

A cadeia de registo.

Tipo de retorno

str

Exceções

NotImplementedError

get_output

Obtenha o resultado do nó com o nome especificado.

get_output(name)

Parâmetros

name

str

Necessário

Nome da saída.

Devoluções

O StepRunOutput com o nome especificado.

Tipo de retorno

StepRunOutput

Exceções

NotImplementedError

get_output_data

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

get_output_data(name)

Parâmetros

name

str

Necessário

Nome da saída.

Devoluções

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

Tipo de retorno

PortDataReference

Exceções

NotImplementedError

get_outputs

Obtenha as saídas dos passos.

get_outputs()

Devoluções

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

Tipo de retorno

dict

Exceções

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

O estado mais recente como uma cadeia

Tipo de retorno

str

Exceções

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

A cadeia de registo.

Tipo de retorno

str

Exceções

NotImplementedError

get_stdout_log

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

get_stdout_log()

Devoluções

A cadeia de registo.

Tipo de retorno

str

Exceções

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

show_output

bool

valor predefinido: True

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

timeout_seconds

int

valor predefinido: 9223372036854775807

Número de segundos a aguardar antes de exceder o tempo limite.

raise_on_error

bool

valor predefinido: True

Indica se deve gerar um erro quando a execução está num estado de falha

Devoluções

O estado final.

Tipo de retorno

str

Exceções

NotImplementedError

Atributos

pipeline_run_id

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

Devoluções

O ID pipelineRun.

Tipo de retorno

str