PipelineEndpoint Класс

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

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

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

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

Инициализация 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: "Активный" или "Отключено".
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: "Активный" или "Отключено".
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. При вызове отправки создается объект, который, в свою очередь, 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: параметры для выполнения конвейера, словарь {name: value}. Дополнительные сведения см. в 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)

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

Методы

add	Добавьте указанный конвейер в PipelineEndpoint.
add_default	Добавьте указанный конвейер в PipelineEndpoint и задайте версию по умолчанию, чтобы добавить добавленную версию конвейера.
archive	Архивируйте PipelineEndpoint.
disable	Установите для PipelineEndpoint значение "Отключено" и недоступно для выполнения.
enable	Задайте для конвейера значение "Активный" и доступно для выполнения.
get	Получение PipelineEndpoint по имени или идентификатору вызывает исключение, если оно не указано.
get_all	Получите все активные точки PipelineEndpoints в текущей рабочей области. Получите все активные pipelineEndpoints. ПРИМЕЧАНИЕ. Этот метод не рекомендуется использовать в пользу PipelineEndpoint.list().
get_all_pipelines	Получение списка конвейеров в PipelineEndpoint. ПРИМЕЧАНИЕ. Этот метод не рекомендуется использовать в пользу list_pipelines()
get_all_versions	Получение списка конвейеров и соответствующих версий в PipelineEndpoint. ПРИМЕЧАНИЕ. Этот метод не рекомендуется использовать в пользу list_versions()
get_default_version	Получите версию PipelineEndpoint по умолчанию.
get_pipeline	Получение конвейера указанной версии или значения по умолчанию; вызывает исключение, если версия не найдена.
list	Вывод списка активных точек PipelineEndpoints в текущей рабочей области.
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	Повторно активируйте конвейерEndpoint, который был архивирован.
set_default	Задайте версию PipelineEndpoint по умолчанию, вызывает исключение, если указанный конвейер не найден.
set_default_version	Задайте версию PipelineEndpoint по умолчанию, вызывает исключение, если указанная версия не найдена.
set_name	Задайте имя PipelineEndpoint.
submit	Отправка эксперимента конвейера заданной версии; Если версия не активирует версию конвейера по умолчанию.

add

Добавьте указанный конвейер в PipelineEndpoint.

add(pipeline)

Параметры

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

add_default

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

add_default(pipeline)

Параметры

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

disable

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

disable()

enable

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

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

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

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

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

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область.
active_only	bool Если задано значение true, возвращаются только активные pipelineEndpoints. 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

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

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

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область.
active_only	bool Если задано значение true, возвращаются только активные pipelineEndpoints. 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

Повторно активируйте конвейерEndpoint, который был архивирован.

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

Отправка эксперимента конвейера заданной версии; Если версия не активирует версию конвейера по умолчанию.

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

Параметры

Имя	Описание
experiment_name Обязательно	str Имя эксперимента для отправки конвейера.
pipeline_parameters	dict Параметры для использования в выполнении конвейера, переданные в качестве словаря {name: value}. Дополнительные сведения см. в 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 конвейера.

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

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

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