PipelineDraft Klasse

Referenz

Stellt eine veränderliche Pipeline dar, mit der Ausführungen übermittelt und veröffentlichte Pipelines erstellt werden können.

Verwenden Sie PipelineDrafts, um Pipelines zu durchlaufen. PipelineDrafts können von Grund auf neu erstellt werden oder auf der Grundlage eines anderen PipelineDraft oder auf der Grundlage vorhandener Pipelines erstellt werden: Pipeline, PublishedPipelineoder PipelineRun.

Initialisieren Sie PipelineDraft.

Vererbung: builtins.object

PipelineDraft

Konstruktor

PipelineDraft(workspace, id, name=None, description=None, experiment_name=None, tags=None, properties=None, graph_draft_id=None, parent_pipeline_id=None, parent_pipeline_run_id=None, parent_step_run_ids=None, parent_pipeline_draft_id=None, last_submitted_pipeline_run_id=None, _pipeline_draft_provider=None)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Das Arbeitsbereichsobjekt für diesen PipelineDraft.
id Erforderlich	str Rufen Sie die ID des PipelineDraft ab.
name Erforderlich	str Der Name des PipelineDraft.
description Erforderlich	str Die Beschreibung des PipelineDraft.
experiment_name Erforderlich	str Der Experimentname für den PipelineDraft.
tags Erforderlich	Dict[str, str] Ein optionales Tagwörterbuch für den PipelineDraft.
properties Erforderlich	Dict[str, str] Ein optionales Eigenschaftenwörterbuch für den PipelineDraft.
graph_draft_id Erforderlich	str Die ID des Graphentwurfs, der dem PipelineDraft zugeordnet ist.
parent_pipeline_id Erforderlich	str Die ID der übergeordneten PublishedPipeline.
parent_pipeline_run_id Erforderlich	str Die ID der übergeordneten PipelineRun.
parent_step_run_ids Erforderlich	list Eine Liste der StepRun-IDs der übergeordneten PipelineRun.
parent_pipeline_draft_id Erforderlich	str Die ID des übergeordneten PipelineDraft.
last_submitted_pipeline_run_id Erforderlich	str Die ID der letzten übermittelten PipelineRun.
_pipeline_draft_provider Erforderlich	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> (Nur interne Verwendung.) Der PipelineDraft-Anbieter.
workspace Erforderlich	Workspace Arbeitsbereichsobjekt für diese PipelineDraft.
id Erforderlich	str Die ID der PipelineDraft.
name Erforderlich	str Der Name des PipelineDraft.
description Erforderlich	str Die Beschreibung des PipelineDraft.
experiment_name Erforderlich	str Der Experimentname für den PipelineDraft.
tags Erforderlich	Dict[str, str] Tagswörterbuch für pipelineDraft.
properties Erforderlich	Dict[str, str] Eigenschaftenwörterbuch für pipelineDraft.
graph_draft_id Erforderlich	str Die ID des Diagrammentwurfs, der pipelineDraft zugeordnet ist.
parent_pipeline_id Erforderlich	str Die ID der übergeordneten PublishedPipeline.
parent_pipeline_run_id Erforderlich	str Die ID des übergeordneten PipelineRun.
parent_step_run_ids Erforderlich	list Eine Liste der StepRun-IDs des übergeordneten PipelineRun-Objekts.
parent_pipeline_draft_id Erforderlich	str Die ID des übergeordneten PipelineDraft-Objekts.
last_submitted_pipeline_run_id Erforderlich	str Die ID des letzten übermittelten PipelineRun.
_pipeline_draft_provider Erforderlich	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> Der PipelineDraft-Anbieter.

Hinweise

Ein PipelineDraft kann mithilfe der create-Funktion auf der Grundlage einer Pipeline erstellt werden. Ein Beispiel finden Sie unten:


   from azureml.pipeline.core import Pipeline, PipelineDraft
   from azureml.pipeline.steps import PythonScriptStep

   train_step = PythonScriptStep(name="Training_Step",
                                 script_name="train.py",
                                 compute_target=aml_compute_target,
                                 source_directory=".")
   pipeline = Pipeline(workspace=ws, steps=[train_step])
   pipeline_draft = PipelineDraft.create(workspace=ws,
                                         name="TestPipelineDraft",
                                         description="draft description",
                                         experiment_name="helloworld",
                                         pipeline=pipeline,
                                         continue_on_step_failure=True,
                                         tags={'dev': 'true'},
                                         properties={'train': 'value'})

Der Pipelineparameter von PipelineDraft.create() kann auch eine PublishedPipeline, PipelineRun oder ein anderer PipelineDraft sein.

Zur Übermittlung einer Ausführung aus einem PipelineDraft verwenden Sie die submit_run-Methode:


   pipeline_run = pipeline_draft.submit_run()

Zur Aktualisierung eines PipelineDraft verwenden Sie die update-Methode. Die update()-Funktion eines Pipeline-Entwurfs kann verwendet werden, um den Namen, die Beschreibung, den Experimentnamen, die Pipeline-Parameterzuweisungen, die Einstellung für den Schrittfehler und die Pipeline, die PipelineDraft zugeordnet ist, zu aktualisieren.


   new_train_step = PythonScriptStep(name="New_Training_Step",
                                     script_name="train.py",
                                     compute_target=aml_compute_target,
                                     source_directory=source_directory)

   new_pipeline = Pipeline(workspace=ws, steps=[new_train_step])

   pipeline_draft.update(name="UpdatedPipelineDraft",
                         description="has updated train step",
                         pipeline=new_pipeline)

Methoden

create	Erstellen Sie einen PipelineDraft.
delete	Löschen Sie den PipelineDraft.
get	Rufen Sie den PipelineDraft mit der angegebenen ID ab.
get_graph	Rufen Sie den Graph ab, der dem PipelineDraft zugeordnet ist.
list	Rufen Sie alle Pipeline-Entwürfe in einem Arbeitsbereich ab.
publish	Veröffentlichen Sie eine PublishedPipeline aus dem PipelineDraft.
save	Speichern Sie die PipelineDraft-YAML in einer Datei.
submit_run	Übermitteln Sie eine PipelineRun aus dem PipelineDraft.
update	Aktualisieren Sie einen PipelineDraft. Die bereitgestellten Felder werden aktualisiert.

create

Erstellen Sie einen PipelineDraft.

static create(workspace, pipeline, name=None, description=None, experiment_name=None, pipeline_parameters=None, continue_on_step_failure=None, tags=None, properties=None, _workflow_provider=None, _service_endpoint=None)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Das Arbeitsbereichsobjekt, zu dem der PipelineDraft gehören wird.
pipeline Erforderlich	PublishedPipeline oder Pipeline oder PipelineRun oder PipelineDraft Die veröffentlichte Pipeline oder Pipeline.
name	str Der Name des PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt. Standardwert: None
description	str Die Beschreibung des PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt. Standardwert: None
experiment_name	str Der Experimentname für den PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt. Standardwert: None
pipeline_parameters	Dict[str, str] Ein optionales Wörterbuch von Pipeline-Parameterzuweisungen für den PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt. Standardwert: None
continue_on_step_failure	bool Gibt an, ob eine PipelineRun fortgesetzt werden soll, wenn bei einer Schrittausführung für den PipelineDraft ein Fehler auftritt; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt. Standardwert: None
tags	Dict[str, str] Ein optionales Tagwörterbuch für den PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt. Standardwert: None
properties	Dict[str, str] Ein optionales Eigenschaftenwörterbuch für den PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt. Standardwert: None
_service_endpoint	str Der Dienstendpunkt. Standardwert: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Nur interne Verwendung.) Der Workflowanbieter. Standardwert: None

Gibt zurück

Typ	Beschreibung
PipelineDraft	Der erstellte PipelineDraft.

delete

Löschen Sie den PipelineDraft.

delete(_workflow_provider=None)

Parameter

Name	Beschreibung
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Nur interne Verwendung.) Der Workflowanbieter. Standardwert: None

get

Rufen Sie den PipelineDraft mit der angegebenen ID ab.

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

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich, in dem der PipelineDraft erstellt wurde.
id Erforderlich	str Rufen Sie die ID des PipelineDraft ab.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Nur interne Verwendung.) Der Workflowanbieter. Standardwert: None
_service_endpoint	str Der Dienstendpunkt. Standardwert: None

Gibt zurück

Typ	Beschreibung
PipelineDraft	PipelineDraft-Objekt

get_graph

Rufen Sie den Graph ab, der dem PipelineDraft zugeordnet ist.

get_graph(_workflow_provider=None)

Parameter

Name	Beschreibung
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Nur interne Verwendung.) Der Workflowanbieter. Standardwert: None

Gibt zurück

Typ	Beschreibung
Graph	Das Graph-Objekt.

list

Rufen Sie alle Pipeline-Entwürfe in einem Arbeitsbereich ab.

static list(workspace, tags=None, _workflow_provider=None)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich, aus dem Entwürfe aufgeführt werden sollen.
tags	dict Wenn angegeben, werden Entwürfe zurückgegeben, die mit dem angegebenen {"tag": "value"} übereinstimmen. Standardwert: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Nur interne Verwendung.) Der Workflowanbieter. Standardwert: None

Gibt zurück

Typ	Beschreibung
list	Eine Liste von PipelineDraft-Objekten.

publish

Veröffentlichen Sie eine PublishedPipeline aus dem PipelineDraft.

publish(_workflow_provider=None)

Parameter

Name	Beschreibung
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Nur interne Verwendung.) Der Workflowanbieter. Standardwert: None

Gibt zurück

Typ	Beschreibung
PublishedPipeline	Die erstellte PublishedPipeline.

save

Speichern Sie die PipelineDraft-YAML in einer Datei.

save(path=None, _workflow_provider=None)

Parameter

Name	Beschreibung
path	str Der Pfad zum Speichern der YAML-Datei. Wenn der Pfad ein Verzeichnis ist, wird die PipelineDraft-YAML-Datei unter path/pipeline_name.yml gespeichert. Bei „None“ wird das aktuelle Verzeichnis verwendet. Standardwert: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Nur interne Verwendung.) Der Workflowanbieter. Standardwert: None

Gibt zurück

Typ	Beschreibung
None

submit_run

Übermitteln Sie eine PipelineRun aus dem PipelineDraft.

submit_run(_workflow_provider=None)

Parameter

Name	Beschreibung
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Nur interne Verwendung.) Der Workflowanbieter. Standardwert: None

Gibt zurück

Typ	Beschreibung
PipelineRun	Die übermittelte PipelineRun.

update

Aktualisieren Sie einen PipelineDraft.

Die bereitgestellten Felder werden aktualisiert.

update(pipeline=None, name=None, description=None, experiment_name=None, tags=None, pipeline_parameters=None, continue_on_step_failure=None, _workflow_provider=None)

Parameter

Name	Beschreibung
pipeline	Pipeline Die aktualisierte Pipeline für den Entwurf. Standardwert: None
name	str Der Name des PipelineDraft. Standardwert: None
description	str Die Beschreibung des PipelineDraft. Standardwert: None
experiment_name	str Der Experimentname für den PipelineDraft. Standardwert: None
tags	Dict[str, str] Ein Tagwörterbuch für den PipelineDraft. Standardwert: None
pipeline_parameters	Dict[str, str] Die Pipeline-Parameterzuweisungen für den PipelineDraft. Standardwert: None
continue_on_step_failure	bool Gibt an, ob die PipelineRun fortgesetzt werden soll, wenn bei einer Schrittausführung für den PipelineDraft ein Fehler auftritt. Standardwert: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Nur interne Verwendung.) Der Workflowanbieter. Standardwert: None

Attribute

description

Rufen Sie die Beschreibung des PipelineDraft ab.

Gibt zurück

Typ	Beschreibung
str	Die Beschreibungszeichenfolge.

id

Rufen Sie die ID des PipelineDraft ab.

Gibt zurück

Typ	Beschreibung
str	Die ID.

last_submitted_pipeline_run_id

Rufen Sie die ID der letzten übermittelten PipelineRun des PipelineDraft ab.

Gibt zurück

Typ	Beschreibung
str	Die PipelineRun-ID.

name

Rufen Sie den Namen des PipelineDraft ab.

Gibt zurück

Typ	Beschreibung
str	Der Name.

parent_pipeline_draft_id

Rufen Sie die ID des übergeordneten PipelineDraft des PipelineDraft ab.

Gibt zurück

Typ	Beschreibung
str	Die PipelineDraft-ID.

parent_pipeline_id

Rufen Sie die ID der übergeordneten PublishedPipeline des PipelineDraft ab.

Gibt zurück

Typ	Beschreibung
str	Die PublishedPipeline-ID.

parent_pipeline_run_id

Rufen Sie die ID der übergeordneten PipelineRun des PipelineDraft ab.

Gibt zurück

Typ	Beschreibung
str	Die PipelineRun-ID.

parent_step_run_ids

Rufen Sie die Liste der StepRun-IDs der übergeordneten PipelineRun des PipelineDraft ab.

Gibt zurück

Typ	Beschreibung
list	Eine Liste der StepRun-IDs.

properties

Rufen Sie die Eigenschaften des PipelineDraft ab.

Gibt zurück

Typ	Beschreibung
dict	Das Eigenschaftenwörterbuch.

Freigeben über

PipelineDraft Klasse

Konstruktor

Parameter

Hinweise

Methoden

create

Parameter

Gibt zurück

delete

Parameter

get

Parameter

Gibt zurück

get_graph

Parameter

Gibt zurück

list

Parameter

Gibt zurück

publish

Parameter

Gibt zurück

save

Parameter

Gibt zurück

submit_run

Parameter

Gibt zurück

update

Parameter

Attribute

description

Gibt zurück

id

Gibt zurück

last_submitted_pipeline_run_id

Gibt zurück

name

Gibt zurück

parent_pipeline_draft_id

Gibt zurück

parent_pipeline_id

Gibt zurück

parent_pipeline_run_id

Gibt zurück

parent_step_run_ids

Gibt zurück

properties

Gibt zurück

tags

Gibt zurück

Feedback

Zusätzliche Ressourcen