StepRun Класс

Выполнение шага в .Pipeline

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

Инициализация 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. Получите все stepRuns в 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 для получения сведений о выполнении и журналов, созданных с помощью запуска.

StepRun также можно использовать для скачивания выходных данных выполнения. Используется 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	Получение последнего состояния запуска конвейера из службы. К общим значениям, возвращаемым, относятся "Выполнение", "Готово" и "Сбой".
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	Возвращает состояние выполнения с содержимым файла журнала

get_job_log

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

get_job_log()

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

Тип	Описание
str	Строка журнала.

get_output

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

get_output(name)

Параметры

Имя	Описание
name Обязательно	str Имя выходных данных.

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

Тип	Описание
StepRunOutput	StepRunOutput с заданным именем.

get_output_data

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

get_output_data(name)

Параметры

Имя	Описание
name Обязательно	str Имя выходных данных.

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

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

get_outputs

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

get_outputs()

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

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

get_status

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

К общим значениям, возвращаемым, относятся "Выполнение", "Готово" и "Сбой".

get_status()

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

Тип	Описание
str	Последнее состояние в виде строки

Комментарии

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

• Очередь — задание находится в очереди.

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

• Сбой — сбой выполнения. Обычно свойство Error во время выполнения предоставляет сведения о том, почему.

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

• Отменено. После запроса на отмену выполнение теперь успешно отменено.

   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	Строка журнала.

get_stdout_log

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

get_stdout_log()

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

Тип	Описание
str	Строка журнала.

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	Окончательное состояние.

Атрибуты

pipeline_run_id

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

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

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