StepRun Класс

  • Ссылка

Выполнение этапа в Pipeline.

Этот класс можно использовать для управления, проверки состояния и получения сведений о выполнении после отправки выполнения родительского конвейера и отправки выполнения этапа конвейером.

Инициализация StepRun.

Наследование
Run
StepRun

Конструктор

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)

Параметры

experiment
Experiment
Обязательно

Объект эксперимента выполнения этапа.

step_run_id
str
Обязательно

Идентификатор выполнения этапа.

pipeline_run_id
str
Обязательно

Идентификатор выполнения родительского конвейера.

node_id
str
Обязательно

Идентификатор узла графа, представляющего этот этап.

_service_endpoint
str
значение по умолчанию: None

Конечная точка для подключения.

_is_reused
bool
значение по умолчанию: False

Указывает, является ли это выполнение повторно используемым предыдущим выполнением.

_current_node_id
str
значение по умолчанию: None

Для повторно используемого узла — идентификатор узла на текущем графе.

_reused_run_id
str
значение по умолчанию: None

Идентификатор повторно используемого выполнения.

_reused_node_id
str
значение по умолчанию: None

Идентификатор повторно используемого узла.

_reused_pipeline_run_id
str
значение по умолчанию: None

Идентификатор повторно используемого конвейера.

experiment
Experiment
Обязательно

Объект эксперимента выполнения этапа.

step_run_id
str
Обязательно

Идентификатор выполнения этапа.

pipeline_run_id
str
Обязательно

Идентификатор выполнения родительского конвейера.

node_id
str
Обязательно

Идентификатор узла графа, представляющего этот этап.

_service_endpoint
str
Обязательно

Конечная точка для подключения.

_is_reused
bool
Обязательно

Указывает, является ли это выполнение повторно используемым предыдущим выполнением.

_current_node_id
str
Обязательно

Для повторно используемого узла — идентификатор узла на текущем графе.

_reused_run_id
Обязательно
_reused_node_id
str
Обязательно
_reused_pipeline_run_id
str
Обязательно

Комментарии

StepRun создается в качестве дочернего выполнения отправленного PipelineRun. Извлеките все StepRun в PipelineRun следующим образом:


   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()

Используйте get_details_with_logs для получения сведений о выполнении и журналах, созданных выполнением.

PipelineRun также можно использовать для загрузки выходных данных выполнения. Используйте get_outputs для получения словаря выходных данных этапа или используйте get_output для получения одного StepRunOutput объекта для выходных данных с указанным именем. Кроме того, можно использовать get_output_data для получения PortDataReference для указанных выходных данных этапа напрямую.

Ниже приведен пример загрузки выходных данных этапа.


   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")

Методы

child_run

Дочернее выполнение для выполнения этапа. Этот метод не реализован для StepRun.
complete

Завершено для выполнения этапа. Этот метод не реализован для StepRun.
fail

Сбой при выполнении этапа. Этот метод не реализован для StepRun.
get_details_with_logs

Возвращает сведения о состоянии выполнения с содержимым файла журнала.
get_job_log

Выведите дамп текущего журнала заданий для выполнения этапа.
get_output

Получение выхода узла с заданным именем.
get_output_data

Получение выходных данных из заданного выхода.
get_outputs

Возвращает выходные данные этапа.
get_status

Получение последнего состояния запуска конвейера от службы.

Обычно возвращаются значения Running, Finished и Failed.
get_stderr_log

Выведите дамп текущего журнала stderr для выполнения этапа.
get_stdout_log

Создание дампа текущего журнала stdout для выполнения этапа.
wait_for_completion

Ожидает завершения этого выполнения этапа.

Возвращает состояние после ожидания.

child_run

Дочернее выполнение для выполнения этапа. Этот метод не реализован для StepRun.

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

Параметры

name
str
значение по умолчанию: None

Необязательное имя дочернего элемента

run_id
str
значение по умолчанию: None

Необязательный run_id для дочернего элемента; в противном случае используется значение по умолчанию

outputs
str
значение по умолчанию: None

Необязательный каталог выходных данных для отслеживания дочернего запуска

Возвращаемое значение

Дочернее выполнение.

Возвращаемый тип

Run

Исключения

NotImplementedError

complete

Завершено для выполнения этапа. Этот метод не реализован для StepRun.

complete()

Исключения

NotImplementedError

fail

Сбой при выполнении этапа. Этот метод не реализован для StepRun.

fail()

Исключения

NotImplementedError

get_details_with_logs

Возвращает сведения о состоянии выполнения с содержимым файла журнала.

get_details_with_logs()

Возвращаемое значение

Возвращает состояние выполнения с содержимым файла журнала.

Возвращаемый тип

dict

Исключения

NotImplementedError

get_job_log

Выведите дамп текущего журнала заданий для выполнения этапа.

get_job_log()

Возвращаемое значение

Строка журнала.

Возвращаемый тип

str

Исключения

NotImplementedError

get_output

Получение выхода узла с заданным именем.

get_output(name)

Параметры

name
str
Обязательно

Имя выходных данных.

Возвращаемое значение

StepRunOutput с заданным именем.

Возвращаемый тип

StepRunOutput

Исключения

NotImplementedError

get_output_data

Получение выходных данных из заданного выхода.

get_output_data(name)

Параметры

name
str
Обязательно

Имя выходных данных.

Возвращаемое значение

PortDataReference, представляющий выходные данные этапа.

Возвращаемый тип

PortDataReference

Исключения

NotImplementedError

get_outputs

Возвращает выходные данные этапа.

get_outputs()

Возвращаемое значение

Словарь StepRunOutputs с именем выхода в качестве ключа.

Возвращаемый тип

dict

Исключения

NotImplementedError

get_status

Получение последнего состояния запуска конвейера от службы.

Обычно возвращаются значения Running, Finished и Failed.

get_status()

Возвращаемое значение

Последнее состояние в виде строки

Возвращаемый тип

str

Исключения

NotImplementedError

Комментарии

  • NotStarted — это временное состояние объектов запуска на стороне клиента перед отправкой в облако

  • Queued — задание поставлено в очередь.

  • Running — начинается запуск задания в целевом объекте вычислений.

  • Failed — сбой запуска. Подробное описание причины как правило предоставляет свойство Error.

  • Finished — выполнение успешно завершено.

  • Canceled — после запроса на отмену выполнение успешно отменено.


   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

Выведите дамп текущего журнала stderr для выполнения этапа.

get_stderr_log()

Возвращаемое значение

Строка журнала.

Возвращаемый тип

str

Исключения

NotImplementedError

get_stdout_log

Создание дампа текущего журнала stdout для выполнения этапа.

get_stdout_log()

Возвращаемое значение

Строка журнала.

Возвращаемый тип

str

Исключения

NotImplementedError

wait_for_completion

Ожидает завершения этого выполнения этапа.

Возвращает состояние после ожидания.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

Параметры

show_output
bool
значение по умолчанию: True

Параметр show_output=True показывает состояние выполнения конвейера в sys.stdout.

timeout_seconds
int
значение по умолчанию: 9223372036854775807

Количество секунд перед истечением времени ожидания.

raise_on_error
bool
значение по умолчанию: True

Указывает, происходит ли ошибка, если выполнение находится в состоянии сбоя.

Возвращаемое значение

Конечное состояние.

Возвращаемый тип

str

Исключения

NotImplementedError

Атрибуты

pipeline_run_id

Возврат идентификатора выполнения конвейера, соответствующего этому выполнению этапа.

Возвращаемое значение

Идентификатор PipelineRun.

Возвращаемый тип

str