PipelineEndpoint Klasse

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

PipelineEndpoints können verwendet werden, um neue Versionen eines PublishedPipeline Endpunkts zu erstellen und gleichzeitig denselben Endpunkt beizubehalten. PipelineEndpoints werden innerhalb eines Arbeitsbereichs eindeutig benannt.

Mithilfe des Endpunktattributs eines PipelineEndpoint-Objekts können Sie neue Pipelineausführungen aus externen Anwendungen mit REST-Aufrufen auslösen. Informationen zum Authentifizieren 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.

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 in PipelineEndpoint beginnt automatisch mit "0".
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 der PipelineIdVersion Objekte.
_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 dieser 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 der Pipeline wird ausgeführt.
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 der Pipelineausführung.

Hinweise

Ein PipelineEndpoint kann entweder aus einem Pipeline oder einem .PublishedPipeline

Ein Beispiel für die Veröffentlichung aus einer Pipeline oder PublishedPipeline lautet wie folgt:


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

Senden Sie einen PipelineEndpoint mithilfe von submit. Beim Senden wird ein PipelineRun Objekt erstellt, das wiederum Objekte für jeden Schritt im Workflow erstellt StepRun .

Ein Beispiel für die Übermittlung eines PipelineEndpoint lautet wie folgt:


   from azureml.pipeline.core import PipelineEndpoint

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

Es gibt eine Reihe optionaler Einstellungen, die beim Übermitteln eines PipelineEndpoint angegeben werden können. Dazu gehören:

pipeline_parameters: Parameter für die Pipelineausführung, Wörterbuch von {name: value}. 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 in RunHistory widerzuspiegeln ist. Die übergeordnete Ausführung muss zum gleichen Experiment gehören wie die, an die diese Pipeline übermittelt wird.
pipeline_version: Die auszuführende Pipelineversion.

Ein Beispiel zum Übermitteln eines PipelineEndpoint mit diesen Einstellungen lautet wie folgt:


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

So fügen Sie eine neue Version einer PipelineEndpoint-Verwendung hinzu:


   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 Notizbuch: https://aka.ms/pl-ver-endpoint

Methoden

add	Fügen Sie die angegebene Pipeline zu PipelineEndpoint hinzu.
add_default	Fügen Sie die angegebene Pipeline zu PipelineEndpoint hinzu, und legen Sie die Standardversion auf die hinzugefügte Pipelineversion fest.
archive	Archiv the PipelineEndpoint.
disable	Legen Sie "PipelineEndpoint" auf "Deaktiviert" fest und ist nicht zur Ausführung verfügbar.
enable	Legen Sie "PipelineEndpoint" auf "Aktiv" fest und ist für die Ausführung verfügbar.
get	Ruft den PipelineEndpoint anhand des Namens oder der ID ab, löst eine Ausnahme aus, wenn keines angegeben ist.
get_all	Ruft alle aktiven PipelineEndpoints im aktuellen Arbeitsbereich ab. Ruft alle aktiven PipelineEndpoints ab. HINWEIS: Diese Methode ist zugunsten von PipelineEndpoint.list() veraltet.
get_all_pipelines	Liste der Pipelines in PipelineEndpoint abrufen. HINWEIS: Diese Methode wird zugunsten von list_pipelines() nicht mehr unterstützt.
get_all_versions	Dient zum Abrufen einer Liste von Pipelines und entsprechenden Versionen in PipelineEndpoint. HINWEIS: Diese Methode ist zugunsten von list_versions() veraltet.
get_default_version	Rufen Sie die Standardversion von PipelineEndpoint ab.
get_pipeline	Abrufen der Pipeline einer angegebenen Version oder des Standardwerts; löst eine Ausnahme aus, wenn die Version nicht gefunden wird.
list	Aktive PipelineEndpoints im aktuellen Arbeitsbereich auflisten.
list_pipelines	Dient zum Abrufen einer Liste von Pipelines, die dem PipelineEndpoint zugeordnet sind.
list_versions	Dient zum Abrufen einer Liste von Pipelines und entsprechenden Versionen von PipelineEndpoint.
publish	Erstellen Sie einen PipelineEndpoint mit dem angegebenen Namen und der pipeline/veröffentlichten Pipeline. Der Pipelineendpunkt ist eine REST-API, die von externen Anwendungen verwendet werden kann. Informationen zum Authentifizieren beim Aufrufen von REST-Endpunkten finden Sie unter https://aka.ms/pl-restep-auth. Weitere Informationen zum Arbeiten mit 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 Sie einen pipelineEndpoint, der archiviert wurde.
set_default	Legen Sie die Standardversion von PipelineEndpoint fest, löst eine Ausnahme aus, wenn die angegebene Pipeline nicht gefunden wird.
set_default_version	Legen Sie die Standardversion von PipelineEndpoint fest, löst eine Ausnahme aus, wenn die angegebene Version nicht gefunden wird.
set_name	Legen Sie den Namen von PipelineEndpoint fest.
submit	Übermitteln eines Pipelineexperiments einer bestimmten Version; wenn keine Version die Standardversion der Pipeline auslöst.

add

Fügen Sie die angegebene Pipeline zu PipelineEndpoint hinzu.

add(pipeline)

Parameter

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

add_default

Fügen Sie die angegebene Pipeline zu PipelineEndpoint hinzu, und legen Sie die Standardversion auf die hinzugefügte Pipelineversion fest.

add_default(pipeline)

Parameter

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

disable

Legen Sie "PipelineEndpoint" auf "Deaktiviert" fest und ist nicht zur Ausführung verfügbar.

disable()

enable

Legen Sie "PipelineEndpoint" auf "Aktiv" fest und ist für die Ausführung verfügbar.

enable()

get

Ruft den PipelineEndpoint anhand des Namens oder der ID ab, löst eine Ausnahme aus, wenn keines angegeben ist.

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

Ruft alle aktiven PipelineEndpoints im aktuellen Arbeitsbereich ab.

Ruft alle aktiven PipelineEndpoints ab. HINWEIS: Diese Methode ist zugunsten von PipelineEndpoint.list() veraltet.

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

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich.
active_only	bool Wenn true, geben Sie nur PipelineEndpoints zurück, 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 der PipelineEndpoint Objekte.

get_all_pipelines

Liste der Pipelines in PipelineEndpoint abrufen.

HINWEIS: Diese Methode wird zugunsten von list_pipelines() nicht mehr unterstützt.

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

Parameter

Name	Beschreibung
active_only	bool Kennzeichnen, 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 der PublishedPipeline Objekte.

get_all_versions

Dient zum Abrufen einer Liste von Pipelines und entsprechenden Versionen in PipelineEndpoint.

HINWEIS: Diese Methode ist zugunsten von list_versions() veraltet.

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 der PipelineVersion Objekte.

get_default_version

Rufen Sie die Standardversion von PipelineEndpoint ab.

get_default_version()

Gibt zurück

Typ	Beschreibung
str	Die Standardversion des Pipelineendpunkts.

get_pipeline

Abrufen der Pipeline einer angegebenen Version oder des Standardwerts; 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

Aktive PipelineEndpoints im aktuellen Arbeitsbereich auflisten.

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 Wenn true, geben Sie nur PipelineEndpoints zurück, die derzeit aktiv sind. Standardwert: True
max_results	int max. Zeilen der zurückgegebenen 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 der PipelineEndpoint Objekte.

list_pipelines

Dient zum Abrufen einer Liste von 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 der PublishedPipeline Objekte.

list_versions

Dient zum Abrufen einer Liste von Pipelines und entsprechenden Versionen von 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 der PipelineVersion Objekte.

publish

Erstellen Sie einen PipelineEndpoint mit dem angegebenen Namen und der pipeline/veröffentlichten Pipeline.

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

Weitere Informationen zum Arbeiten mit 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 Sie einen pipelineEndpoint, der archiviert wurde.

reactivate(name)

Parameter

Name	Beschreibung
name Erforderlich	str Der festzulegende Name.

Gibt zurück

Typ	Beschreibung
PipelineEndpoint	Ein PipelineEndpoint-Objekt.

set_default

Legen Sie die Standardversion von PipelineEndpoint fest, 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

Legen Sie die Standardversion von PipelineEndpoint fest, 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 in PipelineEndpoint festgelegt werden soll.

Ausnahmen

Typ	Beschreibung
ValueError

set_name

Legen Sie den Namen von PipelineEndpoint fest.

set_name(name)

Parameter

Name	Beschreibung
name Erforderlich	str Der festzulegende Name.

submit

Übermitteln eines Pipelineexperiments einer bestimmten Version; wenn keine Version die Standardversion der Pipeline auslö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, in das die Pipeline übermittelt werden soll.
pipeline_parameters	dict Parameter, die in der Pipelineausführung verwendet werden sollen, werden als Wörterbuch von {name: value} übergeben. 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 in RunHistory widerzuspiegeln ist. Die übergeordnete Ausführung muss zu dem Experiment gehören, an das diese Pipeline übermittelt wird. Standardwert: None
pipeline_version	str Die Auszuführende Pipelineversion. Standardwert: None

Gibt zurück

Typ	Beschreibung
PipelineRun	Die übermittelte Pipeline wird ausgeführt.

Ausnahmen

Typ	Beschreibung
ValueError

Attribute

default_version

Rufen Sie die Standardversion von PipelineEndpoint ab.

Gibt zurück

Typ	Beschreibung
str	Die Standardversion.

description

Rufen Sie die Beschreibung des PipelineEndpoint ab.

Gibt zurück

Typ	Beschreibung
str	Die Beschreibung.

endpoint

Rufen Sie die REST-Endpunkt-URL des PipelineEndpoint ab.

Der Endpunkt kann verwendet werden, um Ausführung der Pipeline auszulösen.

Gibt zurück

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

id

Rufen Sie die ID des PipelineEndpoint ab.

Gibt zurück

Typ	Beschreibung
str	Die ID des PipelineEndpoint.

name

Rufen Sie den Namen des PipelineEndpoint ab.

Gibt zurück

Typ	Beschreibung
str	Der Name.

pipeline_version_list

Rufen Sie die Pipelineversionsliste ab.

Gibt zurück

Typ	Beschreibung
list	Die Liste der PipelineIdVersion Objekte.

status

Rufen Sie den Status der PipelineEndpoint ab.

Gibt zurück

Typ	Beschreibung
str	Der Status.

swaggerurl

Rufen Sie die REST-Swagger-URL des PipelineEndpoint ab.

Die Swagger-URL kann das Schema des Pipelineendpunkts anzeigen.

Gibt zurück

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

Feedback

War diese Seite hilfreich?

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