PipelineEndpoint Класс

Ссылка

Представляет рабочий процесс Pipeline, который можно запустить из уникального URL-адреса конечной точки.

Объекты PipelineEndpoint можно использовать для создания новых версий PublishedPipeline, при этом сохраняя одну и ту же конечную точку. PipelineEndpoint имеют уникальные имена в пределах рабочей области.

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

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

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

Наследование: builtins.object

PipelineEndpoint

Конструктор

PipelineEndpoint(workspace, id, name, description, status, default_version, endpoint, pipeline_version_list, _pipeline_endpoint_provider=None, _published_pipeline_provider=None, _swaggerurl=None)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, в которой определен объект PipelineEndpoint.
id Обязательно	str Идентификатор PipelineEndpoint.
name Обязательно	str Имя PipelineEndpoint.
description Обязательно	str Описание PipelineEndpoint.
status Обязательно	str Новое состояние PipelineEndpoint: Active (Активно) или Disabled (Отключено).
default_version Обязательно	str Версия конвейера в PipelineEndpoint по умолчанию с автоматическим приращением, начинается с "0".
endpoint Обязательно	str URL-адрес конечной точки REST для PipelineEndpoint, который можно использовать для отправки выполнений конвейера.
pipeline_version_list Обязательно	list Список объектов PipelineIdVersion.
_pipeline_endpoint_provider Обязательно	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Поставщик PipelineEndpoint.
_pipeline_endpoint_provider Обязательно	Поставщик PublishedPipeline.
workspace Обязательно	Workspace Объект рабочей области, к которому будет принадлежать pipelineEndpoint.
id Обязательно	str Идентификатор PipelineEndpoint.
name Обязательно	str Имя PipelineEndpoint.
description Обязательно	str Описание PipelineEndpoint.
status Обязательно	str Новое состояние PipelineEndpoint: Active (Активно) или Disabled (Отключено).
default_version Обязательно	str Версия конвейера по умолчанию в PipelineEndpoint с автоматическим приращением начинается с "0".
endpoint Обязательно	str URL-адрес конечной точки REST для PipelineEndpoint для отправки запусков конвейера.
pipeline_version_list Обязательно	list Список PipelineIdVersion.
_pipeline_endpoint_provider Обязательно	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Поставщик PipelineEndpoint.
_pipeline_endpoint_provider Обязательно	Поставщик PublishedPipeline.
swaggerendpoint Обязательно	URL-адрес конечной точки REST Swagger для PipelineEndpoint для отправки запусков конвейера.


   from azureml.pipeline.core import PipelineEndpoint

   # The pipeline argument can be either a Pipeline or a PublishedPipeline
   pipeline_endpoint = PipelineEndpoint.publish(workspace=ws,
                                                name="PipelineEndpointName",
                                                pipeline=pipeline,
                                                description="New Pipeline Endpoint")

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

Ниже приведен пример отправки PipelineEndpoint:


   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint)

Существует ряд необязательных параметров, которые можно указать при отправке PipelineEndpoint. Они перечислены ниже.

pipeline_parameters: параметры для выполнения конвейера, словарь {имя: значение}. Дополнительные сведения см. в статье PipelineParameter.
parent_run_id: можно указать идентификатор выполнения, чтобы задать родительское выполнение для этого выполнения конвейера, которое отображается в RunHistory. Родительское выполнение должно относиться к тому же эксперименту, в который отправляется этот конвейер.
pipeline_version: версия конвейера, которую нужно выполнить.

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


   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>",
                                    pipeline_version="0")

Чтобы добавить новую версию PipelineEndpoint, используйте следующий код:


   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_endpoint.add(published_pipeline)

Дополнительные сведения о создании и использовании PipelineEndpoint см. в следующей записной книжке: https://aka.ms/pl-ver-endpoint.

Методы

add	Добавление указанного конвейера в PipelineEndpoint.
add_default	Добавление указанного конвейера в PipelineEndpoint и задание добавленной версии конвейера в качестве версии по умолчанию.
archive	Архивация PipelineEndpoint.
disable	Установка значения Disabled (Отключено) для параметра PipelineEndpoint, в результате чего он становится недоступным для выполнения.
enable	Установка значения Active (Активно) для параметра PipelineEndpoint, в результате чего он становится доступным для выполнения.
get	Получение PipelineEndpoint по имени или идентификатору. Генерирует исключение, если одно из этих значений не указано.
get_all	Получение всех активных PipelineEndpoint в текущей рабочей области. Получение всех активных PipelineEndpoint. ПРИМЕЧАНИЕ. Этот метод является устаревшим, лучше использовать PipelineEndpoint.list().
get_all_pipelines	Получение списка конвейеров в PipelineEndpoint. ПРИМЕЧАНИЕ. Этот метод является устаревшим, лучше использовать list_pipelines().
get_all_versions	Получение списка конвейеров и соответствующих версий в PipelineEndpoint. ПРИМЕЧАНИЕ. Этот метод является устаревшим, лучше использовать list_versions().
get_default_version	Получение версии PipelineEndpoint по умолчанию.
get_pipeline	Получение конвейера указанной версии или версии по умолчанию. Генерирует исключение, если версия не найдена.
list	Список активных PipelineEndpoint в текущей рабочей области.
list_pipelines	Получение списка конвейеров, связанных с PipelineEndpoint.
list_versions	Получение списка конвейеров и соответствующих версий в PipelineEndpoint.
publish	Создание PipelineEndpoint с указанным именем и конвейером или опубликованным конвейером. Конечная точка конвейера — это REST API, который можно использовать из внешних приложений. Дополнительные сведения о проверке подлинности при вызове конечных точек REST см. здесь: https://aka.ms/pl-restep-auth. Дополнительные сведения о работе с конечными точками конвейера см. здесь: https://aka.ms/pl-first-pipeline. Генерирует исключение, если PipelineEndpoint с заданным именем уже существует.
reactivate	Повторная активация архивированного объекта PipelineEndpoint.
set_default	Задание версии PipelineEndpoint по умолчанию. Генерирует исключение, если указанный конвейер не найден.
set_default_version	Задание версии PipelineEndpoint по умолчанию. Генерирует исключение, если указанная версия не найдена.
set_name	Задание имени PipelineEndpoint.
submit	Отправка эксперимента для конвейера определенной версии. Если версия имеет значение None (Нет), используется версия конвейера по умолчанию.

add

Добавление указанного конвейера в PipelineEndpoint.

add(pipeline)

Параметры

Имя	Описание
pipeline Обязательно	PublishedPipeline Опубликованный конвейер, который нужно добавить.

add_default

Добавление указанного конвейера в PipelineEndpoint и задание добавленной версии конвейера в качестве версии по умолчанию.

add_default(pipeline)

Параметры

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

disable

Установка значения Disabled (Отключено) для параметра PipelineEndpoint, в результате чего он становится недоступным для выполнения.

disable()

enable

Установка значения Active (Активно) для параметра PipelineEndpoint, в результате чего он становится доступным для выполнения.

enable()

get

Получение PipelineEndpoint по имени или идентификатору. Генерирует исключение, если одно из этих значений не указано.

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

Параметры

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

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

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

get_all

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

Получение всех активных PipelineEndpoint. ПРИМЕЧАНИЕ. Этот метод является устаревшим, лучше использовать PipelineEndpoint.list().

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

Параметры

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

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

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

get_all_pipelines

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

ПРИМЕЧАНИЕ. Этот метод является устаревшим, лучше использовать list_pipelines().

get_all_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Параметры

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

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

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

get_all_versions

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

ПРИМЕЧАНИЕ. Этот метод является устаревшим, лучше использовать list_versions().

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Параметры

Имя	Описание
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Поставщик рабочего процесса. Default value: None
_service_endpoint	str Конечная точка службы. Default value: None

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

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

get_default_version

Получение версии PipelineEndpoint по умолчанию.

get_default_version()

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

Тип	Описание
str	Версия конечной точки конвейера по умолчанию.

get_pipeline

Получение конвейера указанной версии или версии по умолчанию. Генерирует исключение, если версия не найдена.

get_pipeline(version=None)

Параметры

Имя	Описание
version	str Версия возвращаемого конвейера. Default value: None

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

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

list

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

static list(workspace, active_only=True, max_results=100, _workflow_provider=None, _service_endpoint=None)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область.
active_only	bool Если задано значение true, возвращаются только PipelineEndpoint, активные в данный момент. Default value: True
max_results	int max lines of returned PipelineEndpoints Default value: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Поставщик рабочего процесса. Default value: None
_service_endpoint	str Конечная точка службы. Default value: None

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

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

list_pipelines

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

list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Параметры

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

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

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

list_versions

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

list_versions(_workflow_provider=None, _service_endpoint=None)

Параметры

Имя	Описание
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Поставщик рабочего процесса. Default value: None
_service_endpoint	str Конечная точка службы. Default value: None

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

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

publish

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

Конечная точка конвейера — это REST API, который можно использовать из внешних приложений. Дополнительные сведения о проверке подлинности при вызове конечных точек REST см. здесь: https://aka.ms/pl-restep-auth.

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

Генерирует исключение, если PipelineEndpoint с заданным именем уже существует.

static publish(workspace, name, description, pipeline, _workflow_provider=None, _service_endpoint=None)

Параметры

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

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

Тип	Описание
PipelineEndpoint	Новый объект PipelineEndpoint.

Исключения

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

reactivate

Повторная активация архивированного объекта PipelineEndpoint.

reactivate(name)

Параметры

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

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

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

set_default

Задание версии PipelineEndpoint по умолчанию. Генерирует исключение, если указанный конвейер не найден.

set_default(pipeline)

Параметры

Имя	Описание
pipeline Обязательно	PublishedPipeline Опубликованный конвейер, который нужно задать по умолчанию.

Исключения

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

set_default_version

Задание версии PipelineEndpoint по умолчанию. Генерирует исключение, если указанная версия не найдена.

set_default_version(version)

Параметры

Имя	Описание
version Обязательно	str Версия, которую нужно задать в качестве версии по умолчанию в PipelineEndpoint.

Исключения

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

set_name

Задание имени PipelineEndpoint.

set_name(name)

Параметры

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

submit

Отправка эксперимента для конвейера определенной версии. Если версия имеет значение None (Нет), используется версия конвейера по умолчанию.

submit(experiment_name, pipeline_parameters=None, parent_run_id=None, pipeline_version=None)

Параметры

Имя	Описание
experiment_name Обязательно	str Имя эксперимента, в который необходимо отправить конвейер.
pipeline_parameters	dict Параметры, которые нужно использовать при выполнении конвейера, передаются в виде словаря {имя: значение}. Дополнительные сведения см. в статье PipelineParameter. Default value: None
parent_run_id	str Можно указать идентификатор выполнения, чтобы задать родительское выполнение для этого выполнения конвейера, которое отображается в RunHistory. Родительское выполнение должно относиться к тому же эксперименту, в который отправляется этот конвейер. Default value: None
pipeline_version	str Версия конвейера для выполнения. Default value: None

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

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

Исключения

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

Атрибуты

default_version

Получение версии PipelineEndpoint по умолчанию.

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

Тип	Описание
str	Версия по умолчанию.

description

Получение описания PipelineEndpoint.

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

Тип	Описание
str	Описание.

endpoint

Получение URL-адреса конечной точки REST для PipelineEndpoint.

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

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

Тип	Описание
str	Конечная точка REST, с помощью которой PipelineEndpoint будет выполнять конвейер.

id

Получение идентификатора PipelineEndpoint.

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

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

name

Получение имени PipelineEndpoint.

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

Тип	Описание
str	Имя.

pipeline_version_list

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

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

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

status

Получение состояния PipelineEndpoint.

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

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

swaggerurl

Получение URL-адреса REST Swagger для PipelineEndpoint.

URL-адрес Swagger может быть схемой представления конечной точки конвейера.

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

Тип	Описание
str	Платформа REST Swagger, с помощью которой PipelineEndpoint будет выполнять конвейер.

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

PipelineEndpoint Класс

Конструктор

Параметры

Комментарии

Методы

add

Параметры

add_default

Параметры

archive

disable

enable

get

Параметры

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

get_all

Параметры

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

get_all_pipelines

Параметры

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

get_all_versions

Параметры

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

get_default_version

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

get_pipeline

Параметры

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

list

Параметры

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

list_pipelines

Параметры

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

list_versions

Параметры

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

publish

Параметры

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

Исключения

reactivate

Параметры

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

set_default

Параметры

Исключения

set_default_version

Параметры

Исключения

set_name

Параметры

submit

Параметры

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

Исключения

Атрибуты

default_version

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

description

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

endpoint

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

id

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

name

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

pipeline_version_list

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

status

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

swaggerurl

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

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

Дополнительные ресурсы