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
Обязательно

Имя искомого этапа.

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

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

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

list

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

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

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

Список объектов PipelineRun.

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

list

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

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

Список объектов StepRun.

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

list

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
значение по умолчанию: None

Следует ли продолжать выполнение других шагов в PipelineRun, если шаг завершается ошибкой. Значение по умолчанию — False.

kwargs
dict
Обязательно

Пользовательские аргументы ключевого слова, зарезервированные для будущей разработки

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

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

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

PublishedPipeline

save

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

save(path=None)

Параметры

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

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

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

None

wait_for_completion

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

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

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

Параметры

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

Указывает, показывать ли состояние выполнения конвейера в sys. stdout.

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

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

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

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

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

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

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

str