反馈

PipelineEndpoint 类

  • 参考

表示可以从唯一终结点 URL 触发的 Pipeline 工作流。

PipelineEndpoints 可用于创建 PublishedPipeline 的新版本，同时维护相同的终结点。 PipelineEndpoints 在工作区中的命名是唯一的。

使用 PipelineEndpoint 对象的终结点属性，可以使用 REST 调用从外部应用程序触发新的管道运行。 有关如何在调用 REST 终结点时进行身份验证的信息，请参阅 https://aka.ms/pl-restep-auth。

有关创建和运行机器学习管道的信息，请参阅 https://aka.ms/pl-first-pipeline。

继承
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 的 ID。

name
str
必需

PipelineEndpoint 的名称。

description
str
必需

PipelineEndpoint 的说明。

status
str
必需

PipelineEndpoint 的新状态：“Active”或“Disabled”。

default_version
str
必需

PipelineEndpoint 中管道的默认版本自动递增，从 0 开始。

endpoint
str
必需

PipelineEndpoint 的 REST 终结点 URL，可用于提交管道运行。

pipeline_version_list
list
必需

PipelineIdVersion 对象的列表。

_pipeline_endpoint_provider
<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>
必需

PipelineEndpoint 提供程序。

_pipeline_endpoint_provider
必需

PublishedPipeline 提供程序。

注解

可以从 Pipeline 或 PublishedPipeline 创建 PipelineEndpoint。

从 Pipeline 或 PublishedPipeline 发布的示例如下所示：


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

使用 submit 提交 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：可以提供运行 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 设置为“Disabled”且无法运行。
enable

将 PipelineEndpoint 设置为“Active”并可以运行。
get

按名称或 ID 获取 PipelineEndpoint，如果未提供名称和 ID，则会引发异常。
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。

如果已存在具有给定名称的管道终结点，则引发异常。
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
必需

要添加为默认版本的已发布管道。

archive

存档 PipelineEndpoint。

archive()

disable

将 PipelineEndpoint 设置为“Disabled”且无法运行。

disable()

enable

将 PipelineEndpoint 设置为“Active”并可以运行。

enable()

get

按名称或 ID 获取 PipelineEndpoint，如果未提供名称和 ID，则会引发异常。

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

参数

workspace
Workspace
必需

创建 PipelineEndpoint 的工作区。

id
str
默认值: None

PipelineEndpoint 的 ID。

name
str
默认值: None

PipelineEndpoint 的名称。

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
默认值: None

工作流提供程序。

_service_endpoint
str
默认值: 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

如果为 true，则仅返回当前处于活动状态的 PipelineEndpoints。

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
默认值: None

工作流提供程序。

_service_endpoint
str
默认值: None

服务终结点。

返回

PipelineEndpoint 对象的列表。

返回类型

list

get_all_pipelines

获取 PipelineEndpoint 中的管道列表。

注意：此方法已弃用，取而代之的是 list_pipelines()

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

参数

active_only
bool
默认值: True

表示仅返回活动管道的标志。

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
默认值: None

工作流提供程序。

_service_endpoint
str
默认值: None

服务终结点。

返回

PublishedPipeline 对象的列表。

返回类型

list

get_all_versions

获取 PipelineEndpoint 中管道和相应版本的列表。

注意：此方法已弃用，取而代之的是 list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

参数

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
默认值: None

工作流提供程序。

_service_endpoint
str
默认值: None

服务终结点。

返回

PipelineVersion 对象的列表。

返回类型

list

get_default_version

获取 PipelineEndpoint 的默认版本。

get_default_version()

返回

管道终结点的默认版本。

返回类型

str

get_pipeline

获取指定版本或默认版本的管道；如果未找到版本，则引发异常。

get_pipeline(version=None)

参数

version
str
默认值: None

要返回的管道的版本。

返回

已发布管道。

返回类型

PublishedPipeline

list

列出当前工作区中活动的 PipelineEndpoint。

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

参数

workspace
Workspace
必需

工作区。

active_only
bool
默认值: True

如果为 true，则仅返回当前处于活动状态的 PipelineEndpoints。

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
默认值: None

工作流提供程序。

_service_endpoint
str
默认值: None

服务终结点。

返回

PipelineEndpoint 对象的列表。

返回类型

list

list_pipelines

获取与 PipelineEndpoint 关联的管道的列表。

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

参数

active_only
bool
默认值: True

指示是否仅返回活动管道。

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
默认值: None

工作流提供程序。

_service_endpoint
str
默认值: None

服务终结点。

返回

PublishedPipeline 对象的列表。

返回类型

list

list_versions

获取 PipelineEndpoint 的管道和相应版本的列表。

list_versions(_workflow_provider=None, _service_endpoint=None)

参数

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
默认值: None

工作流提供程序。

_service_endpoint
str
默认值: None

服务终结点。

返回

PipelineVersion 对象的列表。

返回类型

list

publish

使用指定的名称和管道/已发布的管道创建 PipelineEndpoint。

管道终结点是一个 REST API，可以从外部应用程序使用。 有关如何在调用 REST 终结点时进行身份验证的信息，请参阅 https://aka.ms/pl-restep-auth。

有关使用管道终结点的详细信息，请参阅 https://aka.ms/pl-first-pipeline。

如果已存在具有给定名称的管道终结点，则引发异常。

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
默认值: None

服务终结点。

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
默认值: 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
默认值: None

要在管道执行中使用的参数，作为 {name: value} 的字典传递。 有关详细信息，请参阅 PipelineParameter 。

parent_run_id
str
默认值: None

可以提供运行 ID 来设置此管道运行的父运行，该运行反映在 RunHistory 中。 父运行必须与提交此管道时所属于的实验相同。

pipeline_version
str
默认值: None

要运行的管道的版本。

返回

已提交的管道运行。

返回类型

PipelineRun

例外

ValueError

属性

default_version

获取 PipelineEndpoint 的默认版本。

返回

默认版本。

返回类型

str

description

获取 PipelineEndpoint 的说明。

返回

说明。

返回类型

str

endpoint

获取 PipelineEndpoint 的 REST 终结点 URL。

终结点可用于触发管道运行。

返回

供 PipelineEndpoint 运行管道的 REST 终结点。

返回类型

str

id

获取 PipelineEndpoint 的 ID。

返回

PipelineEndpoint 的 ID。

返回类型

str

name

获取 PipelineEndpoint 的名称。

返回

名称。

返回类型

str

pipeline_version_list

获取管道版本列表。

返回

PipelineIdVersion 对象的列表。

返回类型

list

status

获取 PipelineEndpoint 的状态。

返回

状态。

返回类型

str

swaggerurl

获取 PipelineEndpoint 的 REST Swagger URL。

Swagger URL 可以是管道终结点的视图架构。

返回

供 PipelineEndpoint 运行管道的 REST Swagger。

返回类型

str