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 Конечная точка для подключения. Default value: None
_is_reused	bool Указывает, является ли это выполнение повторно используемым предыдущим выполнением. Default value: False
_current_node_id	str Для повторно используемого узла — идентификатор узла на текущем графе. Default value: None
_reused_run_id	str Идентификатор повторно используемого выполнения. Default value: None
_reused_node_id	str Идентификатор повторно используемого узла. Default value: None
_reused_pipeline_run_id	str Идентификатор повторно используемого конвейера. Default value: 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 Необязательное имя дочернего элемента Default value: None
run_id	str Необязательный run_id для дочернего элемента; в противном случае используется значение по умолчанию Default value: None
outputs	str Необязательный каталог выходных данных для отслеживания дочернего запуска Default value: 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()

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

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

Исключения

Тип	Описание
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 Параметр show_output=True показывает состояние выполнения конвейера в sys.stdout. Default value: True
timeout_seconds	int Количество секунд перед истечением времени ожидания. Default value: 9223372036854775807
raise_on_error	bool Указывает, происходит ли ошибка, если выполнение находится в состоянии сбоя. Default value: True

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

Тип	Описание
str	Конечное состояние.

Исключения

Тип	Описание
NotImplementedError

Атрибуты

pipeline_run_id

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

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

Тип	Описание
str	Идентификатор PipelineRun.