PublishedPipeline Класс

Представляет конвейер для отправки без кода Python, созданного им.

Кроме того, для повторной Pipeline отправки значений PipelineParameter и входных данных можно использовать метод PublishedPipeline.

Инициализация PublishedPipeline.

:p aram конечной точки URL-адрес конечной точки REST для отправки конвейера для этого конвейера. :type endpoint: str :p aram total_run_steps: количество шагов в этом конвейере :type total_run_steps: int :p aram workspace: рабочая область опубликованного конвейера. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: следует ли продолжать выполнение других действий в PipelineRun

Если шаг завершается ошибкой, значение по умолчанию равно false.

Конструктор

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

Параметры

Имя	Описание
name Обязательно	str Имя опубликованного конвейера.
graph_id Обязательно	str Идентификатор графа для этого опубликованного конвейера.
description Обязательно	str Описание опубликованного конвейера.
version Обязательно	str Опубликованная версия конвейера.
published_pipeline_id Обязательно	str Идентификатор опубликованного конвейера.
status Обязательно	str Состояние опубликованного конвейера ("Активный" или "Отключено").
endpoint Обязательно	str URL-адрес конечной точки REST для отправки запусков для этого конвейера.
total_run_steps Обязательно	int Количество шагов в этом конвейере.
workspace Обязательно	Workspace Рабочая область опубликованного конвейера.
continue_on_step_failure Обязательно	bool Следует ли продолжать выполнение других шагов в PipelineRun, если шаг завершается ошибкой. Значение по умолчанию — false.
_pipeline_provider Обязательно	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> Опубликованный поставщик конвейера.
kwargs Обязательно	dict Пользовательские аргументы ключевых слов, зарезервированные для будущего разработки
name Обязательно	str Имя опубликованного конвейера.
graph_id Обязательно	str Идентификатор графа для этого опубликованного конвейера.
description Обязательно	str Описание опубликованного конвейера.
version Обязательно	str Опубликованная версия конвейера.
published_pipeline_id Обязательно	str Идентификатор опубликованного конвейера.
status Обязательно	str Состояние опубликованного конвейера ("Активный" или "Отключено").
_pipeline_provider Обязательно	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> Опубликованный поставщик конвейера.
kwargs Обязательно	dict Пользовательские аргументы ключевых слов, зарезервированные для будущего разработки


   from azureml.pipeline.core import Pipeline

   pipeline = Pipeline(workspace=ws, steps=steps)
   published_pipeline = pipeline.publish(name="My_New_Pipeline",
                                         description="My New Pipeline Description",
                                         version="1.0",
                                         continue_on_step_failure=True)

Для публикации из PipelineRun используется:


   from azureml.pipeline.core import PipelineRun

   pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
   published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
                                                      description="My New Pipeline Description",
                                                      version="1.0",
                                                      continue_on_step_failure=True)

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

Отправка опубликованнойpipeline с помощью submit. При вызове отправки создается объект, который, в свою очередь, PipelineRun создает StepRun объекты для каждого шага рабочего процесса.

Ниже приведен пример отправки объекта PublishedPipeline:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

При отправке опубликованнойPipeline можно указать ряд необязательных параметров. К ним относятся:

continue_on_step_failure: следует ли продолжать выполнение других шагов в PipelineRun, если шаг завершается сбоем, необязательным. Только шаги, которые не зависят от выходных данных неудачного шага, будут продолжать выполняться. Если этот параметр указан, этот параметр переопределяет параметр конвейера.
pipeline_parameters: параметры для выполнения конвейера, словарь {name: value}. Дополнительные сведения см. в PipelineParameter.
parent_run_id. Вы можете указать идентификатор запуска, чтобы задать родительский запуск этого запуска конвейера, который отражается в RunHistory. Родительский запуск должен принадлежать тому же эксперименту, что и отправленный конвейер.

Пример отправки PublishedPipeline с помощью этих параметров выглядит следующим образом:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline,
                                    continue_on_step_failure=True,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>")

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

Использование конечной точки обеспечивает "управляемую повторяемость" в сценариях пакетной оценки и переобучения, например. Дополнительные сведения см. в разделе https://aka.ms/pl-first-pipeline.

Методы

disable	Установите для опубликованного конвейера значение "Отключено" и недоступно для выполнения.
enable	Задайте для опубликованного конвейера значение "Активный" и доступно для выполнения.
get	Получение опубликованного конвейера.
get_all	Получение всех опубликованных конвейеров в текущей рабочей области. DEPRECATED: этот метод устарел в пользу метода PublishedPipeline list .
get_graph	Получите граф объекта PublishedPipeline.
get_step_names	Получите список имен шагов в PublishedPipeline.
list	Получение всех опубликованных конвейеров в текущей рабочей области.
save	Сохраните YAML конвейера в файл. В настоящее время для экспорта YAML поддерживаются только конвейеры, состоящие из moduleSteps.
submit	Отправьте опубликованный конвейер. Это эквивалентно использованию submit. Возвращает отправленный PipelineRunобъект. Используйте этот объект для мониторинга и просмотра сведений о выполнении.

disable

Установите для опубликованного конвейера значение "Отключено" и недоступно для выполнения.

disable()

enable

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

enable()

get

Получение опубликованного конвейера.

static get(workspace, id, _workflow_provider=None, _service_endpoint=None)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, в которую был создан опубликованный конвейер.
id Обязательно	str Идентификатор опубликованного конвейера.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Поставщик рабочих процессов. Default value: None
_service_endpoint	str Конечная точка службы. Default value: None

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

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

get_all

Получение всех опубликованных конвейеров в текущей рабочей области.

DEPRECATED: этот метод устарел в пользу метода PublishedPipeline list .

static get_all(workspace, active_only=True, _service_endpoint=None)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, в которую был создан опубликованный конвейер.
active_only	bool Следует ли возвращать только опубликованные конвейеры, которые в настоящее время активны. Default value: True
_service_endpoint	str Конечная точка службы. Default value: None

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

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

get_graph

Получите граф объекта PublishedPipeline.

get_graph(_workflow_provider=None)

Параметры

Имя	Описание
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Поставщик рабочих процессов. Default value: None

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

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

get_step_names

Получите список имен шагов в PublishedPipeline.

get_step_names(_workflow_provider=None)

Параметры

Имя	Описание
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Поставщик рабочих процессов. Default value: None

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

Тип	Описание
List[str]	Список имен шагов в publishedPipeline.

list

Получение всех опубликованных конвейеров в текущей рабочей области.

static list(workspace, active_only=True, _service_endpoint=None)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, в которую был создан опубликованный конвейер.
active_only	bool Следует ли возвращать только опубликованные конвейеры, которые в настоящее время активны. Default value: True
_service_endpoint	str Конечная точка службы. Default value: None

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

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

save

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

В настоящее время для экспорта YAML поддерживаются только конвейеры, состоящие из moduleSteps.

save(path=None, _workflow_provider=None)

Параметры

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

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

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

submit

Отправьте опубликованный конвейер. Это эквивалентно использованию submit.

Возвращает отправленный PipelineRunобъект. Используйте этот объект для мониторинга и просмотра сведений о выполнении.

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область для отправки опубликованного конвейера.
experiment_name Обязательно	str Имя эксперимента для отправки.
pipeline_parameters	dict Словарь параметров для назначения новых значений {param name, param value}. Дополнительные сведения см. в PipelineParameter. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Поставщик рабочих процессов. Default value: None
_service_endpoint	str Конечная точка службы. Default value: None
parent_run_id	str Необязательный идентификатор выполнения, заданный для родительского запуска этого конвейера, который отражается в RunHistory. Родительский запуск должен принадлежать тому же эксперименту, в который отправляется этот конвейер. Default value: None
continue_on_step_failure	bool Следует ли продолжать выполнение других шагов в PipelineRun, если шаг завершается сбоем, необязательным. При условии переопределит параметр конвейера. Default value: None

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

Тип	Описание
PipelineRun	Запуск отправленного конвейера.

Атрибуты

continue_on_step_failure

Получите значение continue_on_step_failure параметра.

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

Тип	Описание
bool	Значение `continue_on_step_failure` параметра.

description

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

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

Тип	Описание
str	Описание опубликованного конвейера.

endpoint

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

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

Тип	Описание
str	URL-адрес конечной точки REST для запуска опубликованного конвейера.

graph_id

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

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

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

id

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

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

Тип	Описание
str	Идентификатор опубликованного конвейера.

name

Получите имя опубликованного конвейера.

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

Тип	Описание
str	Опубликованное имя конвейера.

status

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

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

Тип	Описание
str	Состояние опубликованного конвейера.

total_run_steps

Получите количество шагов в конвейере.

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

Тип	Описание
int	Количество шагов в конвейере.

version

Получите версию опубликованного конвейера.

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

Тип	Описание
str	Версия опубликованного конвейера.

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

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

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

PublishedPipeline Класс

Конструктор

Параметры

Комментарии

Методы

disable

enable

get

Параметры

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

get_all

Параметры

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

get_graph

Параметры

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

get_step_names

Параметры

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

list

Параметры

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

save

Параметры

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

submit

Параметры

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

Атрибуты

continue_on_step_failure

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

description

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

endpoint

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

graph_id

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

id

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

name

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

status

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

total_run_steps

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

version

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

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