Freigeben über


PublishedPipeline Klasse

Stellt eine Pipeline dar, die ohne den für ihre Erstellung verwendeten Python-Code übermittelt werden soll.

Darüber hinaus kann eine PublishedPipeline verwendet werden, um eine Pipeline mit anderen PipelineParameter-Werten und Eingaben erneut zu übermitteln.

Initialisieren Sie PublishedPipeline.

:p aram-Endpunkt Die REST-Endpunkt-URL zum Übermitteln von Pipelineausführungen für diese Pipeline. :type endpoint: str :p aram total_run_steps: Die Anzahl der Schritte in dieser Pipeline :type total_run_steps: int :p aram workspace: Der Arbeitsbereich der veröffentlichten Pipeline. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: Gibt an, ob die Ausführung anderer Schritte in PipelineRun fortgesetzt werden soll

Wenn ein Schritt fehlschlägt, ist der Standardwert false.

Vererbung
azureml.core._portal.HasPipelinePortal
PublishedPipeline

Konstruktor

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

Parameter

name
str
Erforderlich

Der Name der veröffentlichten Pipeline.

graph_id
str
Erforderlich

Die ID des Graphen für diese veröffentlichte Pipeline.

description
str
Erforderlich

Die Beschreibung der veröffentlichten Pipeline.

version
str
Erforderlich

Die Version der veröffentlichten Pipeline.

published_pipeline_id
str
Erforderlich

Die ID der veröffentlichten Pipeline.

status
str
Erforderlich

Der Status der veröffentlichten Pipeline („Aktiv“ oder „Deaktiviert“).

endpoint
str
Erforderlich

Die REST-Endpunkt-URL zum Übermitteln von Ausführungen für diese Pipeline.

total_run_steps
int
Erforderlich

Die Anzahl von Schritten in dieser Pipeline.

workspace
Workspace
Erforderlich

Der Arbeitsbereich der veröffentlichten Pipeline.

continue_on_step_failure
bool
Erforderlich

Gibt an, ob die Ausführung weiterer Schritte in der Pipelineausführung (PipelineRun) fortgesetzt werden soll, wenn bei einem Schritt ein Fehler auftritt. Die Standardeinstellung ist „false“.

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Erforderlich

Der Anbieter der veröffentlichten Pipeline.

kwargs
dict
Erforderlich

Benutzerdefinierte Schlüsselwortargumente, für die zukünftige Entwicklung reserviert.

name
str
Erforderlich

Der Name der veröffentlichten Pipeline.

graph_id
str
Erforderlich

Die ID des Graphen für diese veröffentlichte Pipeline.

description
str
Erforderlich

Die Beschreibung der veröffentlichten Pipeline.

version
str
Erforderlich

Die Version der veröffentlichten Pipeline.

published_pipeline_id
str
Erforderlich

Die ID der veröffentlichten Pipeline.

status
str
Erforderlich

Status der veröffentlichten Pipeline ("Aktiv" oder "Deaktiviert").

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Erforderlich

Der Anbieter der veröffentlichten Pipeline.

kwargs
dict
Erforderlich

Benutzerdefinierte Schlüsselwortargumente, für die zukünftige Entwicklung reserviert.

Hinweise

Eine PublishedPipeline kann aus einer Pipeline oder einer PipelineRun erstellt werden.

Das folgende Beispiel veranschaulicht die Veröffentlichung über eine Pipeline:


   from azureml.pipeline.core import Pipeline

   pipeline = Pipeline(workspace=ws, steps=steps)
   published_pipeline = pipeline.publish(name="My_New_Pipeline",
                                         description="My New Pipeline Description",
                                         version="1.0",
                                         continue_on_step_failure=True)

Verwenden Sie zum Veröffentlichen über eine PipelineRun den folgenden Code:


   from azureml.pipeline.core import PipelineRun

   pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
   published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
                                                      description="My New Pipeline Description",
                                                      version="1.0",
                                                      continue_on_step_failure=True)

Hinweis: Der Parameter „continue_on_step_failure“ gibt an, ob die Ausführung von Schritten in der Pipeline fortgesetzt wird, wenn bei einem Schritt ein Fehler auftritt. Der Standardwert ist „False“. Dies bedeutet, dass die Pipelineausführung beendet wird und alle aktuell ausgeführten Schritte abgebrochen werden, wenn bei einem Schritt ein Fehler auftritt.

Übermitteln einer PublishedPipeline mit submit. Wenn „submit“ aufgerufen wird, wird eine PipelineRun erstellt, die wiederum StepRun-Objekte für jeden Schritt im Workflow erstellt.

Das folgende Beispiel veranschaulicht das Übermitteln einer PublishedPipeline:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

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

  • continue_on_step_failure: Gibt an, ob die Ausführung weiterer Schritte in der PipelineRun fortgesetzt werden soll, wenn bei einem Schritt ein Fehler auftritt (optional). Nur Schritte, die keine Abhängigkeit von der Ausgabe des fehlgeschlagenen Schritts aufweisen, werden weiterhin ausgeführt. Wenn angegeben, überschreibt diese Parametereinstellung die Einstellung für die Pipeline.

  • 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 die Pipeline übermittelt wird.

Das folgende Beispiel veranschaulicht die Übermittlung einer PublishedPipeline mit diesen Einstellungen:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline,
                                    continue_on_step_failure=True,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>")

Alle veröffentlichten Pipelines weisen einen REST-Endpunkt auf. Mit dem Pipelineendpunkt können Sie über externe Systeme (einschließlich Nicht-Python-Clients) eine Ausführung der Pipeline auslösen. Informationen zur Authentifizierung beim Aufrufen von REST-Endpunkten finden Sie unter https://aka.ms/pl-restep-auth.

Die Verwendung des Endpunkts ermöglicht beispielsweise „verwaltete Wiederholbarkeit“ in Szenarios für die Batchbewertung und für erneutes Training. Weitere Informationen finden Sie unter https://aka.ms/pl-first-pipeline.

Methoden

disable

Festlegen der veröffentlichten Pipeline auf „Deaktiviert“, sodass sie nicht zur Ausführung verfügbar ist.

enable

Festlegen der veröffentlichten Pipeline auf „Aktiv“, sodass sie zur Ausführung verfügbar ist.

get

Abrufen der veröffentlichten Pipeline.

get_all

Abrufen aller veröffentlichten Pipelines im aktuellen Arbeitsbereich.

VERALTET: Diese Methode ist veraltet und wurde durch die PublishedPipeline-Methode list ersetzt.

get_graph

Abrufen des Graphen der PublishedPipeline.

get_step_names

Abrufen der Liste mit den Namen der Schritte in der PublishedPipeline.

list

Abrufen aller veröffentlichten Pipelines im aktuellen Arbeitsbereich.

save

Speichern der YAML-Pipeline in einer Datei.

Derzeit werden für den YAML-Export nur Pipelines unterstützt, die aus Modulschritten (ModuleSteps) bestehen.

submit

Übermitteln der veröffentlichten Pipeline. Dies entspricht der Verwendung von submit.

Gibt die übermittelte PipelineRun zurück. Verwenden Sie dieses Objekt, um Details zur Ausführung zu überwachen und anzuzeigen.

disable

Festlegen der veröffentlichten Pipeline auf „Deaktiviert“, sodass sie nicht zur Ausführung verfügbar ist.

disable()

enable

Festlegen der veröffentlichten Pipeline auf „Aktiv“, sodass sie zur Ausführung verfügbar ist.

enable()

get

Abrufen der veröffentlichten Pipeline.

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

Parameter

workspace
Workspace
Erforderlich

Der Arbeitsbereich, in dem die veröffentlichte Pipeline erstellt wurde.

id
str
Erforderlich

Die ID der veröffentlichten Pipeline.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Standardwert: None

Der Workflowanbieter.

_service_endpoint
str
Standardwert: None

Der Dienstendpunkt.

Gibt zurück

Ein PublishedPipeline-Objekt.

Rückgabetyp

get_all

Abrufen aller veröffentlichten Pipelines im aktuellen Arbeitsbereich.

VERALTET: Diese Methode ist veraltet und wurde durch die PublishedPipeline-Methode list ersetzt.

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

Parameter

workspace
Workspace
Erforderlich

Der Arbeitsbereich, in dem die veröffentlichte Pipeline erstellt wurde.

active_only
bool
Standardwert: True

Gibt an, ob nur veröffentlichte Pipelines, die derzeit aktiv sind, zurückgeben werden sollen.

_service_endpoint
str
Standardwert: None

Der Dienstendpunkt.

Gibt zurück

Eine Liste von PublishedPipeline-Objekten.

Rückgabetyp

get_graph

Abrufen des Graphen der PublishedPipeline.

get_graph(_workflow_provider=None)

Parameter

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Standardwert: None

Der Workflowanbieter.

Gibt zurück

Das Diagramm.

Rückgabetyp

get_step_names

Abrufen der Liste mit den Namen der Schritte in der PublishedPipeline.

get_step_names(_workflow_provider=None)

Parameter

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Standardwert: None

Der Workflowanbieter.

Gibt zurück

Die Liste mit den Namen der Schritte in der PublishedPipeline.

Rückgabetyp

list

Abrufen aller veröffentlichten Pipelines im aktuellen Arbeitsbereich.

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

Parameter

workspace
Workspace
Erforderlich

Der Arbeitsbereich, in dem die veröffentlichte Pipeline erstellt wurde.

active_only
bool
Standardwert: True

Gibt an, ob nur veröffentlichte Pipelines, die derzeit aktiv sind, zurückgeben werden sollen.

_service_endpoint
str
Standardwert: None

Der Dienstendpunkt.

Gibt zurück

Eine Liste von PublishedPipeline-Objekten.

Rückgabetyp

save

Speichern der YAML-Pipeline in einer Datei.

Derzeit werden für den YAML-Export nur Pipelines unterstützt, die aus Modulschritten (ModuleSteps) bestehen.

save(path=None, _workflow_provider=None)

Parameter

path
str
Standardwert: None

Der Pfad zum Speichern der YAML-Datei. Wenn der Pfad ein Verzeichnis ist, wird die YAML-Pipelinedatei unter path/pipeline_name.yml gespeichert. Bei „None“ wird das aktuelle Verzeichnis verwendet.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Standardwert: None

Der Workflowanbieter.

Rückgabetyp

submit

Übermitteln der veröffentlichten Pipeline. Dies entspricht der Verwendung von submit.

Gibt die übermittelte PipelineRun zurück. Verwenden Sie dieses Objekt, um Details zur Ausführung zu überwachen und anzuzeigen.

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

Parameter

workspace
Workspace
Erforderlich

Der Arbeitsbereich, an den die veröffentlichte Pipeline übermittelt werden soll.

experiment_name
str
Erforderlich

Der Name des Experiments, an das die Pipeline übermittelt werden soll.

pipeline_parameters
dict
Standardwert: None

Ein Wörterbuch mit Parametern zum Zuweisen neuer Werte {param name, param value}. Weitere Informationen finden Sie unter PipelineParameter.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Standardwert: None

Der Workflowanbieter.

_service_endpoint
str
Standardwert: None

Der Dienstendpunkt.

parent_run_id
str
Standardwert: None

Eine optionale Ausführungs-ID zum Festlegen der übergeordneten Ausführung dieser Pipelineausführung, die im Ausführungsverlauf (RunHistory) angezeigt wird. Die übergeordnete Ausführung muss zu dem Experiment gehören, an das diese Pipeline übermittelt wird.

continue_on_step_failure
bool
Standardwert: None

Gibt an, ob die Ausführung weiterer Schritte in der PipelineRun fortgesetzt werden soll, wenn bei einem Schritt ein Fehler auftritt (optional). Wenn angegeben, wird die Einstellung für die Pipeline überschrieben.

Gibt zurück

Die übermittelte Pipelineausführung.

Rückgabetyp

Attribute

continue_on_step_failure

Abrufen des Werts der continue_on_step_failure-Einstellung.

Gibt zurück

Der Wert der continue_on_step_failure-Einstellung.

Rückgabetyp

description

Abrufen der Beschreibung der veröffentlichten Pipeline.

Gibt zurück

Die Beschreibung der veröffentlichten Pipeline.

Rückgabetyp

str

endpoint

Abrufen der REST-Endpunkt-URL zum Ausführen der veröffentlichten Pipeline.

Gibt zurück

Die REST-Endpunkt-URL zum Ausführen der veröffentlichten Pipeline.

Rückgabetyp

str

graph_id

Abrufen der ID des Graphen für diese veröffentlichte Pipeline.

Gibt zurück

Die ID des Graphen.

Rückgabetyp

str

id

Abrufen der ID der veröffentlichten Pipeline.

Gibt zurück

Die ID der veröffentlichten Pipeline.

Rückgabetyp

str

name

Abrufen des Namens der veröffentlichten Pipeline.

Gibt zurück

Der Name der veröffentlichten Pipeline.

Rückgabetyp

str

status

Abrufen des Status der veröffentlichten Pipeline.

Gibt zurück

Der Status der veröffentlichten Pipeline.

Rückgabetyp

str

total_run_steps

Abrufen der Anzahl von Schritten in der Pipeline.

Gibt zurück

Die Anzahl von Schritten in der Pipeline.

Rückgabetyp

int

version

Abrufen der Version der veröffentlichten Pipeline.

Gibt zurück

Die Version der veröffentlichten Pipeline.

Rückgabetyp

str