PipelineRun Класс

Представляет выполнение Pipeline.

Этот класс можно использовать для управления, проверки состояния и получения сведений о выполнении после отправки конвейера. Используйте get_steps для получения объектов StepRun, созданных при выполнении конвейера. Другие варианты использования включают получение объекта Graph, связанного с выполнением конвейера, получение состояния выполнения конвейера и ожидание завершения выполнения.

Инициализация выполнения конвейера.

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

Run

PipelineRun

Конструктор

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

Параметры

Имя	Описание
experiment Обязательно	Experiment Объект эксперимента, связанный с выполнением конвейера.
run_id Обязательно	str Идентификатор запуска выполнения конвейера.
_service_endpoint	str Конечная точка для подключения. значение по умолчанию: None
experiment Обязательно	Experiment Объект эксперимента, связанный с выполнением конвейера.
run_id Обязательно	str Идентификатор запуска выполнения конвейера.
_service_endpoint Обязательно	str Конечная точка для подключения.

Комментарии

Объект PipelineRun возвращается при отправке Pipeline через submit. метод Experiment. Для получения дополнительных сведений о создании и отправке конвейера см. https://aka.ms/pl-first-pipeline.

Также можно создать экземпляр PipelineRun с помощью Experiment, в который было отправлено выполнение, и идентификатор PipelineRun следующим образом:

   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

При работе с PipelineRun используйте:

• wait_for_completion для отслеживания состояния выполнения и при необходимости журналы потоковой передачи.

• get_status для получения информации о статусе выполнения.

• cancel для отмены текущего PipelineRun.

• get_steps для вывода списка созданных StepRuns. PipelineRun создает StepRun для каждого шага в конвейере.

Методы

cancel	Отмена текущего выполнения.
child_run	Создайте дочернее выполнение для выполнения конвейера. Этот метод не реализован для PipelineRun.
complete	Помечает выполнение конвейера как завершенное. Этот метод не реализован для PipelineRun. Этот метод не поддерживается для конвейеров; состояние завершения или сбоя управляется серверной частью Машинного обучения Azure.
fail	Пометьте выполнение конвейера как завершившееся сбоем. Этот метод не реализован для PipelineRun. Этот метод не поддерживается для конвейеров; состояние завершения или сбоя управляется серверной частью Машинного обучения Azure.
find_step_run	Поиск этапа, выполняемого в конвейере, по имени.
get	Получение выполнения конвейера на основе идентификатора запуска.
get_graph	Возвращает граф выполнения конвейера.
get_pipeline_output	Получение PortDataReference для заданных выходных данных конвейера.
get_pipeline_runs	Получение выполнений конвейера, созданных на основе опубликованного конвейера.
get_status	Получение последнего состояния запуска конвейера от службы. Обычно возвращаются значения Running, Finished и Failed.
get_steps	Получение выполнений этапа для всех этапов конвейера, которые завершились или начали выполняться.
get_tags	Получение набора тегов для выполнения.
publish_pipeline	Публикация конвейера и обеспечение его доступности для повторного выполнения. Конечную точку конвейера можно получить из объекта PublishedPipeline, возвращаемого этой функцией. С помощью конечной точки конвейера можно вызывать конвейер из внешних приложений, используя вызовы REST. Дополнительные сведения о проверке подлинности при вызове конечных точек REST см. здесь: https://aka.ms/pl-restep-auth. Исходный конвейер, связанный с выполнением конвейера, используется в качестве базы для опубликованного конвейера.
save	Сохранение кода YAML конвейера в файл.
wait_for_completion	Ожидает завершения этого выполнения конвейера. Возвращает состояние после ожидания.

cancel

Отмена текущего выполнения.

cancel()

child_run

Создайте дочернее выполнение для выполнения конвейера. Этот метод не реализован для PipelineRun.

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

Параметры

Имя	Описание
name	str Необязательное имя дочернего элемента. значение по умолчанию: None
run_id	str Необязательный идентификатор запуска для дочернего элемента; в противном случае используется значение по умолчанию. значение по умолчанию: None
outputs	str Необязательный каталог выходных данных для отслеживания дочернего запуска. значение по умолчанию: None

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

Тип	Описание
Run	Дочерний запуск.

Исключения

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

complete

Помечает выполнение конвейера как завершенное. Этот метод не реализован для PipelineRun.

Этот метод не поддерживается для конвейеров; состояние завершения или сбоя управляется серверной частью Машинного обучения Azure.

complete()

Исключения

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

fail

Пометьте выполнение конвейера как завершившееся сбоем. Этот метод не реализован для PipelineRun.

Этот метод не поддерживается для конвейеров; состояние завершения или сбоя управляется серверной частью Машинного обучения Azure.

fail()

Исключения

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

find_step_run

Поиск этапа, выполняемого в конвейере, по имени.

find_step_run(name)

Параметры

Имя	Описание
name Обязательно	str Имя искомого этапа.

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

Тип	Описание
list	Список объектов StepRun с указанным именем.

get

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

static get(workspace, run_id, _service_endpoint=None)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, связанная с конвейером.
run_id Обязательно	str Идентификатор выполнения конвейера.
_service_endpoint	str Конечная точка для подключения. значение по умолчанию: None

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

Тип	Описание
PipelineRun	Объект PipelineRun.

get_graph

Возвращает граф выполнения конвейера.

get_graph()

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

Тип	Описание
Graph	Граф.

get_pipeline_output

Получение PortDataReference для заданных выходных данных конвейера.

get_pipeline_output(pipeline_output_name)

Параметры

Имя	Описание
pipeline_output_name Обязательно	str Имя получаемых выходных данных конвейера.

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

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

get_pipeline_runs

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

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, связанная с конвейером.
pipeline_id Обязательно	str Идентификатор опубликованного конвейера.
_service_endpoint	str Конечная точка для подключения. значение по умолчанию: None

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

Тип	Описание
list	Список объектов PipelineRun.

get_status

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

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

get_status()

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

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

Комментарии

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

• 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_steps

Получение выполнений этапа для всех этапов конвейера, которые завершились или начали выполняться.

get_steps()

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

Тип	Описание
list	Список объектов StepRun.

get_tags

Получение набора тегов для выполнения.

get_tags()

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

Тип	Описание
dict	Словарь тегов для выполнения.

publish_pipeline

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

Конечную точку конвейера можно получить из объекта PublishedPipeline, возвращаемого этой функцией. С помощью конечной точки конвейера можно вызывать конвейер из внешних приложений, используя вызовы REST. Дополнительные сведения о проверке подлинности при вызове конечных точек REST см. здесь: https://aka.ms/pl-restep-auth.

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

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

Параметры

Имя	Описание
name Обязательно	str Имя опубликованного конвейера.
description Обязательно	str Описание опубликованного конвейера.
version Обязательно	str Версия опубликованного конвейера.
continue_on_step_failure	bool Следует ли продолжать выполнение других шагов в PipelineRun, если шаг завершается ошибкой. Значение по умолчанию — False. значение по умолчанию: None
kwargs Обязательно	dict Пользовательские аргументы ключевого слова, зарезервированные для будущей разработки

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

Тип	Описание
PublishedPipeline	Созданный опубликованный конвейер.

save

Сохранение кода YAML конвейера в файл.

save(path=None)

Параметры

Имя	Описание
path	str Путь для сохранения файла YAML. Если путь ведет к каталогу, файл YAML конвейера сохраняется по адресу <path>/pipeline.yml. Если путь имеет значение None, используется текущий каталог. значение по умолчанию: None

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

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

wait_for_completion

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

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

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

Параметры

Имя	Описание
show_output	bool Указывает, показывать ли состояние выполнения конвейера в sys. stdout. значение по умолчанию: True
timeout_seconds	int Количество секунд перед истечением времени ожидания. значение по умолчанию: 9223372036854775807
raise_on_error	bool Указывает, происходит ли ошибка, если выполнение находится в состоянии сбоя. значение по умолчанию: True

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

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