PipelineEndpoint クラス

リファレンス

一意のエンドポイント URL からトリガーできる Pipeline ワークフローを表します。

PipelineEndpoint を使用すると、同じエンドポイントを維持しながら PublishedPipeline の新しいバージョンを作成できます。 PipelineEndpoint には、ワークスペース内で一意の名前が付けられます。

PipelineEndpoint オブジェクトの endpoint 属性を使用すると、外部アプリケーションから 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 の 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 プロバイダー。

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 プロバイダー。

swaggerendpoint

必須

パイプラインの実行を送信する PipelineEndpoint の Swagger REST エンドポイント URL。

注釈

PipelineEndpoint は、Pipeline または PublishedPipeline のいずれからでも作成できます。

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: RunHistory に反映される、このパイプライン実行の親実行を設定する実行 ID を指定できます。親の実行は、このパイプラインが送信されるのと同じ実験に属している必要があります。
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	PipelineEndpoint を 'Disabled' に設定し、実行できないようにします。
enable	PipelineEndpoint を 'Active' に設定し、実行できるようにします。
get	名前または ID で 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

PipelineEndpoint を 'Disabled' に設定し、実行できないようにします。

disable()

enable

PipelineEndpoint を 'Active' に設定し、実行できるようにします。

enable()

get

名前または ID で PipelineEndpoint を取得します。どちらも指定されていない場合は例外をスローします。

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 の場合、現在アクティブな PipelineEndpoint のみを返します。

_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, max_results=100, _workflow_provider=None, _service_endpoint=None)

パラメーター

workspace: Workspace

必須

ワークスペース。

active_only: bool

既定値: True

true の場合、現在アクティブな PipelineEndpoint のみを返します。

max_results: int

既定値: 100

返される 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 を参照してください。

指定した名前の 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

既定値: 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

swaggerurl

PipelineEndpoint の REST Swagger URL を取得します。

Swagger URL は、パイプラインエンドポイントのビュースキーマである場合があります。

戻り値

パイプラインを実行する PipelineEndpoint の REST Swagger。

の戻り値の型 :

str

Share via

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

戻り値

の戻り値の型 :