PipelineRun Класс

Представляет запуск объекта Pipeline.

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

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

Конструктор

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

Параметры

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

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

Конвейер можно также создать экземпляр с помощью отправленного 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	Получение последнего состояния запуска конвейера из службы. К общим значениям, возвращаемым, относятся "Выполнение", "Готово" и "Сбой".
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 Необязательное имя дочернего элемента. Default value: None
run_id	str Необязательный идентификатор выполнения для дочернего элемента в противном случае используется по умолчанию. Default value: None
outputs	str Необязательный каталог выходных данных для отслеживания дочернего элемента. Default value: None

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

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

Исключения

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

complete

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

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

complete()

Исключения

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

fail

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

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 Конечная точка для подключения. Default value: 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 Конечная точка для подключения. Default value: None

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

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

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_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. Default value: None
kwargs Обязательно	dict Пользовательские аргументы ключевых слов, зарезервированные для будущего разработки

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

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

save

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

save(path=None)

Параметры

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

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

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

wait_for_completion

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

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

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

Параметры

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

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

Тип	Описание
str	Окончательное состояние.

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

PipelineRun Класс

Конструктор

Параметры

Комментарии

Методы

cancel

child_run

Параметры

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

Исключения

complete

Исключения

fail

Исключения

find_step_run

Параметры

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

get

Параметры

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

get_graph

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

get_pipeline_output

Параметры

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

get_pipeline_runs

Параметры

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

get_status

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

Комментарии

get_steps

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

get_tags

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

publish_pipeline

Параметры

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

save

Параметры

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

wait_for_completion

Параметры

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

Обратная связь