PipelineEndpoint Klasse

Referenz

Stellt einen Pipeline-Workflow dar, der von einer eindeutigen Endpunkt-URL ausgelöst werden kann.

PipelineEndpoints können verwendet werden, um neue Versionen einer PublishedPipeline unter Beibehaltung desselben Endpunkts zu erstellen. PipelineEndpoints sind innerhalb eines Arbeitsbereichs eindeutig benannt.

Mithilfe des Endpunkt-Attributs eines PipelineEndpoint-Objekts können Sie über externe Anwendungen mit REST-Aufrufen neue Pipelineausführungen auslösen. Informationen zur Authentifizierung beim Aufrufen von REST-Endpunkten finden Sie unter https://aka.ms/pl-restep-auth.

Weitere Informationen zum Erstellen und Ausführen von Machine Learning-Pipelines finden Sie unter https://aka.ms/pl-first-pipeline.

Initialisieren Sie PipelineEndpoint.

Vererbung: builtins.object

PipelineEndpoint

Konstruktor

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

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich, in dem der PipelineEndpoint definiert ist.
id Erforderlich	str Die ID des PipelineEndpoint.
name Erforderlich	str Der Name des PipelineEndpoint.
description Erforderlich	str Die Beschreibung des PipelineEndpoint.
status Erforderlich	str Der neue Status des PipelineEndpoint: „Aktiv“ oder „Deaktiviert“.
default_version Erforderlich	str Die Standardversion der Pipeline im PipelineEndpoint (wird automatisch beginnend bei 0 inkrementiert).
endpoint Erforderlich	str Die REST-Endpunkt-URL für den PipelineEndpoint, die zum Übermitteln von Pipelineausführungen verwendet werden kann.
pipeline_version_list Erforderlich	list Die Liste von PipelineIdVersion-Objekten.
_pipeline_endpoint_provider Erforderlich	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Der PipelineEndpoint-Anbieter.
_pipeline_endpoint_provider Erforderlich	Der PublishedPipeline-Anbieter.
workspace Erforderlich	Workspace Das Arbeitsbereichsobjekt, zu dem PipelineEndpoint gehört.
id Erforderlich	str Die ID des PipelineEndpoint.
name Erforderlich	str Der Name des PipelineEndpoint.
description Erforderlich	str Die Beschreibung des PipelineEndpoint.
status Erforderlich	str Der neue Status des PipelineEndpoint: „Aktiv“ oder „Deaktiviert“.
default_version Erforderlich	str Die Standardversion der Pipeline in PipelineEndpoint, automatische Inkremente, beginnt mit "0".
endpoint Erforderlich	str Die REST-Endpunkt-URL für PipelineEndpoint zum Übermitteln von Pipelineausführungen.
pipeline_version_list Erforderlich	list Die Liste der PipelineIdVersion
_pipeline_endpoint_provider Erforderlich	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Der PipelineEndpoint-Anbieter.
_pipeline_endpoint_provider Erforderlich	Der PublishedPipeline-Anbieter.
swaggerendpoint Erforderlich	Die Swagger-REST-Endpunkt-URL für PipelineEndpoint zum Übermitteln von Pipelineausführungen.

Hinweise

Ein PipelineEndpoint kann basierend auf einer Pipeline oder PublishedPipeline erstellt werden.

Das folgende Beispiel veranschaulicht die Veröffentlichung über eine Pipeline oder 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")

Übermitteln Sie mithilfe von submit einen PipelineEndpoint. Wenn „submit“ aufgerufen wird, wird eine PipelineRun erstellt, die wiederum StepRun-Objekte für jeden Schritt im Workflow erstellt.

Das folgende Beispiel veranschaulicht die Übermittlung eines PipelineEndpoint:


   from azureml.pipeline.core import PipelineEndpoint

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

Es sind mehrere optionale Einstellungen verfügbar, die beim Übermitteln eines PipelineEndpoint angegeben werden können. Dazu gehören:

pipeline_parameters: Parameter für die Pipelineausführung, Wörterbuch mit {name: value}-Paaren. Weitere Informationen finden Sie unter PipelineParameter.
parent_run_id: Sie können eine Ausführungs-ID angeben, um die übergeordnete Ausführung dieser Pipelineausführung festzulegen, die im Ausführungsverlauf (RunHistory) angezeigt wird. Die übergeordnete Ausführung muss zu dem Experiment gehören, an das diese Pipeline übermittelt wird.
pipeline_version: Die auszuführende Pipelineversion.

Das folgende Beispiel veranschaulicht die Übermittlung eines PipelineEndpoint mit diesen Einstellungen:


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

Verwenden Sie zum Hinzufügen einer neuen Version eines PipelineEndpoint den folgenden Code:


   from azureml.pipeline.core import PipelineEndpoint

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

Weitere Informationen zum Erstellen und Verwenden von PipelineEndpoints finden Sie im folgenden Notebook: https://aka.ms/pl-ver-endpoint.

Methoden

add	Hinzufügen der angegebenen Pipeline zum PipelineEndpoint.
add_default	Hinzufügen der angegebenen Pipeline zum PipelineEndpoint und Festlegen der Standardversion auf die hinzugefügte Pipelineversion.
archive	Archivieren des PipelineEndpoint.
disable	Festlegen des PipelineEndpoint auf „Deaktiviert“, sodass er nicht zur Ausführung verfügbar ist.
enable	Festlegen des PipelineEndpoint auf „Aktiv“, sodass er zur Ausführung verfügbar ist.
get	Abrufen des PipelineEndpoint anhand des Namens oder der ID. Löst eine Ausnahme aus, wenn weder der Name noch die ID angegeben werden.
get_all	Abrufen aller aktiven PipelineEndpoints im aktuellen Arbeitsbereich. Abrufen aller aktiven PipelineEndpoints. HINWEIS: Diese Methode ist veraltet und wurde durch „PipelineEndpoint.list()“ ersetzt.
get_all_pipelines	Ruft eine Liste der Pipelines im PipelineEndpoint ab. HINWEIS: Diese Methode ist veraltet und wurde durch „list_pipelines()“ ersetzt.
get_all_versions	Ruft eine Liste der Pipelines und entsprechenden Versionen im PipelineEndpoint ab. HINWEIS: Diese Methode ist veraltet und wurde durch „list_versions()“ ersetzt.
get_default_version	Ruft die Standardversion des PipelineEndpoint ab.
get_pipeline	Abrufen der Pipeline einer angegebenen Version oder der Standardversion. Löst eine Ausnahme aus, wenn die Version nicht gefunden wird.
list	Auflisten der aktiven PipelineEndpoints im aktuellen Arbeitsbereich.
list_pipelines	Abrufen einer Liste der Pipelines, die dem PipelineEndpoint zugeordnet sind.
list_versions	Abrufen einer Liste der Pipelines und entsprechenden Versionen des PipelineEndpoint.
publish	Erstellen eines PipelineEndpoint mit dem angegebenen Namen und der angegebenen Pipeline/veröffentlichten Pipeline. Der Pipelineendpunkt ist eine REST-API, die in externen Anwendungen verwendet werden kann. Informationen zur Authentifizierung beim Aufrufen von REST-Endpunkten finden Sie unter https://aka.ms/pl-restep-auth. Weitere Informationen zum Verwenden von Pipelineendpunkten finden Sie unter https://aka.ms/pl-first-pipeline. Löst eine Ausnahme aus, wenn bereits ein PipelineEndpoint mit dem angegebenen Namen vorhanden ist.
reactivate	Reaktivieren eines archivierten PipelineEndpoint.
set_default	Festlegen der Standardversion des PipelineEndpoint. Löst eine Ausnahme aus, wenn die angegebene Pipeline nicht gefunden wird.
set_default_version	Festlegen der Standardversion des PipelineEndpoint. Löst eine Ausnahme aus, wenn die angegebene Version nicht gefunden wird.
set_name	Festlegen des Namens des PipelineEndpoint.
submit	Übermitteln eines Pipelineexperiments mit einer bestimmten Version. Bei „None“ wird die Standardversion der Pipeline ausgelöst.

add

Hinzufügen der angegebenen Pipeline zum PipelineEndpoint.

add(pipeline)

Parameter

Name	Beschreibung
pipeline Erforderlich	PublishedPipeline Eine veröffentlichte Pipeline, die hinzugefügt werden soll.

add_default

Hinzufügen der angegebenen Pipeline zum PipelineEndpoint und Festlegen der Standardversion auf die hinzugefügte Pipelineversion.

add_default(pipeline)

Parameter

Name	Beschreibung
pipeline Erforderlich	PublishedPipeline Eine veröffentlichte Pipeline, die als Standardversion hinzugefügt werden soll.

disable

Festlegen des PipelineEndpoint auf „Deaktiviert“, sodass er nicht zur Ausführung verfügbar ist.

disable()

enable

Festlegen des PipelineEndpoint auf „Aktiv“, sodass er zur Ausführung verfügbar ist.

enable()

get

Abrufen des PipelineEndpoint anhand des Namens oder der ID. Löst eine Ausnahme aus, wenn weder der Name noch die ID angegeben werden.

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

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich, in dem der PipelineEndpoint erstellt wurde.
id	str Die ID des PipelineEndpoint. Standardwert: None
name	str Der Name des PipelineEndpoint. Standardwert: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Der Workflowanbieter. Standardwert: None
_service_endpoint	str Der Dienstendpunkt. Standardwert: None

Gibt zurück

Typ	Beschreibung
PipelineEndpoint	Das PipelineEndpoint-Objekt.

get_all

Abrufen aller aktiven PipelineEndpoints im aktuellen Arbeitsbereich.

Abrufen aller aktiven PipelineEndpoints. HINWEIS: Diese Methode ist veraltet und wurde durch „PipelineEndpoint.list()“ ersetzt.

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

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich.
active_only	bool Bei „True“ werden nur PipelineEndpoints zurückgegeben, die derzeit aktiv sind. Standardwert: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Der Workflowanbieter. Standardwert: None
_service_endpoint	str Der Dienstendpunkt. Standardwert: None

Gibt zurück

Typ	Beschreibung
list	Die Liste von PipelineEndpoint-Objekten.

get_all_pipelines

Ruft eine Liste der Pipelines im PipelineEndpoint ab.

HINWEIS: Diese Methode ist veraltet und wurde durch „list_pipelines()“ ersetzt.

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

Parameter

Name	Beschreibung
active_only	bool Flag, das festgelegt werden kann, um nur aktive Pipelines zurückzugeben. Standardwert: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Der Workflowanbieter. Standardwert: None
_service_endpoint	str Der Dienstendpunkt. Standardwert: None

Gibt zurück

Typ	Beschreibung
list	Die Liste von PublishedPipeline-Objekten.

get_all_versions

Ruft eine Liste der Pipelines und entsprechenden Versionen im PipelineEndpoint ab.

HINWEIS: Diese Methode ist veraltet und wurde durch „list_versions()“ ersetzt.

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parameter

Name	Beschreibung
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Der Workflowanbieter. Standardwert: None
_service_endpoint	str Der Dienstendpunkt. Standardwert: None

Gibt zurück

Typ	Beschreibung
list	Die Liste von PipelineVersion-Objekten.

get_default_version

Ruft die Standardversion des PipelineEndpoint ab.

get_default_version()

Gibt zurück

Typ	Beschreibung
str	Die Standardversion des Pipelineendpunkts.

get_pipeline

Abrufen der Pipeline einer angegebenen Version oder der Standardversion. Löst eine Ausnahme aus, wenn die Version nicht gefunden wird.

get_pipeline(version=None)

Parameter

Name	Beschreibung
version	str Die Version der Pipeline, die zurückgegeben werden soll. Standardwert: None

Gibt zurück

Typ	Beschreibung
PublishedPipeline	Eine veröffentlichte Pipeline.

list

Auflisten der aktiven PipelineEndpoints im aktuellen Arbeitsbereich.

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

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich.
active_only	bool Bei „True“ werden nur PipelineEndpoints zurückgegeben, die derzeit aktiv sind. Standardwert: True
max_results	int Maximale Zeilenanzahl zurückgegebener PipelineEndpoints Standardwert: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Der Workflowanbieter. Standardwert: None
_service_endpoint	str Der Dienstendpunkt. Standardwert: None

Gibt zurück

Typ	Beschreibung
list	Die Liste von PipelineEndpoint-Objekten.

list_pipelines

Abrufen einer Liste der Pipelines, die dem PipelineEndpoint zugeordnet sind.

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

Parameter

Name	Beschreibung
active_only	bool Gibt an, ob nur aktive Pipelines zurückgegeben werden sollen. Standardwert: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Der Workflowanbieter. Standardwert: None
_service_endpoint	str Der Dienstendpunkt. Standardwert: None

Gibt zurück

Typ	Beschreibung
list	Die Liste von PublishedPipeline-Objekten.

list_versions

Abrufen einer Liste der Pipelines und entsprechenden Versionen des PipelineEndpoint.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parameter

Name	Beschreibung
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Der Workflowanbieter. Standardwert: None
_service_endpoint	str Der Dienstendpunkt. Standardwert: None

Gibt zurück

Typ	Beschreibung
list	Die Liste von PipelineVersion-Objekten.

publish

Erstellen eines PipelineEndpoint mit dem angegebenen Namen und der angegebenen Pipeline/veröffentlichten Pipeline.

Der Pipelineendpunkt ist eine REST-API, die in externen Anwendungen verwendet werden kann. Informationen zur Authentifizierung beim Aufrufen von REST-Endpunkten finden Sie unter https://aka.ms/pl-restep-auth.

Weitere Informationen zum Verwenden von Pipelineendpunkten finden Sie unter https://aka.ms/pl-first-pipeline.

Löst eine Ausnahme aus, wenn bereits ein PipelineEndpoint mit dem angegebenen Namen vorhanden ist.

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

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich, in dem der PipelineEndpoint erstellt werden soll.
name Erforderlich	str Der Name des PipelineEndpoint.
description Erforderlich	str Die Beschreibung des PipelineEndpoint.
pipeline Erforderlich	PublishedPipeline oder Pipeline Die veröffentlichte Pipeline oder Pipeline.
_service_endpoint	str Der Dienstendpunkt. Standardwert: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Der Workflowanbieter. Standardwert: None

Gibt zurück

Typ	Beschreibung
PipelineEndpoint	Ein neuer PipelineEndpoint.

Ausnahmen

Typ	Beschreibung
ValueError

reactivate

Reaktivieren eines archivierten PipelineEndpoint.

reactivate(name)

Parameter

Name	Beschreibung
name Erforderlich	str Der Name, der festgelegt werden soll.

Gibt zurück

Typ	Beschreibung
PipelineEndpoint	Ein PipelineEndpoint-Objekt.

set_default

Festlegen der Standardversion des PipelineEndpoint. Löst eine Ausnahme aus, wenn die angegebene Pipeline nicht gefunden wird.

set_default(pipeline)

Parameter

Name	Beschreibung
pipeline Erforderlich	PublishedPipeline Die veröffentlichte Pipeline, die als Standard festgelegt werden soll.

Ausnahmen

Typ	Beschreibung
ValueError

set_default_version

Festlegen der Standardversion des PipelineEndpoint. Löst eine Ausnahme aus, wenn die angegebene Version nicht gefunden wird.

set_default_version(version)

Parameter

Name	Beschreibung
version Erforderlich	str Die Version, die als Standardversion im PipelineEndpoint festgelegt werden soll.

Ausnahmen

Typ	Beschreibung
ValueError

set_name

Festlegen des Namens des PipelineEndpoint.

set_name(name)

Parameter

Name	Beschreibung
name Erforderlich	str Der Name, der festgelegt werden soll.

submit

Übermitteln eines Pipelineexperiments mit einer bestimmten Version. Bei „None“ wird die Standardversion der Pipeline ausgelöst.

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

Parameter

Name	Beschreibung
experiment_name Erforderlich	str Der Name des Experiments, an das die Pipeline übermittelt werden soll.
pipeline_parameters	dict Bei der Pipelineausführung zu verwendende Parameter, die als Wörterbuch mit {name: value}-Paaren übergeben werden. Weitere Informationen finden Sie unter PipelineParameter. Standardwert: None
parent_run_id	str Sie können eine Ausführungs-ID angeben, um die übergeordnete Ausführung dieser Pipelineausführung festzulegen, die im Ausführungsverlauf (RunHistory) angezeigt wird. Die übergeordnete Ausführung muss zu dem Experiment gehören, an das diese Pipeline übermittelt wird. Standardwert: None
pipeline_version	str Die Version der auszuführenden Pipeline. Standardwert: None

Gibt zurück

Typ	Beschreibung
PipelineRun	Die übermittelte Pipelineausführung.

Ausnahmen

Typ	Beschreibung
ValueError

Attribute

default_version

Abrufen der Standardversion des PipelineEndpoint.

Gibt zurück

Typ	Beschreibung
str	Die Standardversion.

description

Ruft die Beschreibung des PipelineEndpoint ab.

Gibt zurück

Typ	Beschreibung
str	Die Beschreibung.

endpoint

Abrufen der REST-Endpunkt-URL des PipelineEndpoint.

Der Endpunkt kann zum Auslösen von Ausführungen der Pipeline verwendet werden.

Gibt zurück

Typ	Beschreibung
str	REST-Endpunkt für den PipelineEndpoint zum Ausführen der Pipeline.

id

Ruft die ID des PipelineEndpoint ab.

Gibt zurück

Typ	Beschreibung
str	Die ID des PipelineEndpoint.

name

Ruft den Namen des PipelineEndpoint ab.

Gibt zurück

Typ	Beschreibung
str	Der Name.

pipeline_version_list

Ruft die Liste der Pipelineversionen ab.

Gibt zurück

Typ	Beschreibung
list	Die Liste von PipelineIdVersion-Objekten.

status

Ruft den Status des PipelineEndpoint ab.

Gibt zurück

Typ	Beschreibung
str	Der Status.

swaggerurl

Abrufen der REST-Swagger-URL des PipelineEndpoint.

Bei der Swagger-URL kann es sich um das Ansichtsschema des Pipelineendpunkts handeln.

Gibt zurück

Typ	Beschreibung
str	REST-Swagger für den PipelineEndpoint zum Ausführen der Pipeline.

Freigeben über

PipelineEndpoint Klasse

Konstruktor

Parameter

Hinweise

Methoden

add

Parameter

add_default

Parameter

archive

disable

enable

get

Parameter

Gibt zurück

get_all

Parameter

Gibt zurück

get_all_pipelines

Parameter

Gibt zurück

get_all_versions

Parameter

Gibt zurück

get_default_version

Gibt zurück

get_pipeline

Parameter

Gibt zurück

list

Parameter

Gibt zurück

list_pipelines

Parameter

Gibt zurück

list_versions

Parameter

Gibt zurück

publish

Parameter

Gibt zurück

Ausnahmen

reactivate

Parameter

Gibt zurück

set_default

Parameter

Ausnahmen

set_default_version

Parameter

Ausnahmen

set_name

Parameter

submit

Parameter

Gibt zurück

Ausnahmen

Attribute

default_version

Gibt zurück

description

Gibt zurück

endpoint

Gibt zurück

id

Gibt zurück

name

Gibt zurück

pipeline_version_list

Gibt zurück

status

Gibt zurück

swaggerurl

Gibt zurück

Feedback

Zusätzliche Ressourcen