PipelineDraft Klasse

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

workspace
Workspace
Erforderlich

Das Arbeitsbereichsobjekt für diesen PipelineDraft.

id
str
Erforderlich

Rufen Sie die ID des PipelineDraft ab.

name
str
Erforderlich

Der Name des PipelineDraft.

description
str
Erforderlich

Die Beschreibung des PipelineDraft.

experiment_name
str
Erforderlich

Der Experimentname für den PipelineDraft.

tags
Dict[str, str]
Erforderlich

Ein optionales Tagwörterbuch für den PipelineDraft.

properties
Dict[str, str]
Erforderlich

Ein optionales Eigenschaftenwörterbuch für den PipelineDraft.

graph_draft_id
str
Erforderlich

Die ID des Graphentwurfs, der dem PipelineDraft zugeordnet ist.

parent_pipeline_id
str
Erforderlich

Die ID der übergeordneten PublishedPipeline.

parent_pipeline_run_id
str
Erforderlich

Die ID der übergeordneten PipelineRun.

parent_step_run_ids
list
Erforderlich

Eine Liste der StepRun-IDs der übergeordneten PipelineRun.

parent_pipeline_draft_id
str
Erforderlich

Die ID des übergeordneten PipelineDraft.

last_submitted_pipeline_run_id
str
Erforderlich

Die ID der letzten übermittelten PipelineRun.

_pipeline_draft_provider
<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>
Erforderlich

(Nur interne Verwendung.) Der PipelineDraft-Anbieter.

workspace
Workspace
Erforderlich

Workspace-Objekt für diese PipelineDraft.

id
str
Erforderlich

Die ID des PipelineDraft.

name
str
Erforderlich

Der Name des PipelineDraft.

description
str
Erforderlich

Die Beschreibung des PipelineDraft.

experiment_name
str
Erforderlich

Der Experimentname für den PipelineDraft.

tags
Dict[str, str]
Erforderlich

Tags-Wörterbuch für den PipelineDraft.

properties
Dict[str, str]
Erforderlich

Eigenschaftenverzeichnis für pipelineDraft.

graph_draft_id
str
Erforderlich

Die ID des Diagrammentwurfs, der dem PipelineDraft zugeordnet ist.

parent_pipeline_id
str
Erforderlich

Die ID der übergeordneten PublishedPipeline.

parent_pipeline_run_id
str
Erforderlich

The id of the parent PipelineRun.

parent_step_run_ids
list
Erforderlich

Eine Liste der StepRun-IDs des übergeordneten PipelineRun-Objekts.

parent_pipeline_draft_id
str
Erforderlich

The id of the parent PipelineDraft.

last_submitted_pipeline_run_id
str
Erforderlich

The id of the last submitted PipelineRun.

_pipeline_draft_provider
<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>
Erforderlich

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

workspace
Workspace
Erforderlich

Das Arbeitsbereichsobjekt, zu dem der PipelineDraft gehören wird.

pipeline
PublishedPipeline oder Pipeline oder PipelineRun oder PipelineDraft
Erforderlich

Die veröffentlichte Pipeline oder Pipeline.

name
str
Standardwert: None

Der Name des PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt.

description
str
Standardwert: None

Die Beschreibung des PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt.

experiment_name
str
Standardwert: None

Der Experimentname für den PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt.

pipeline_parameters
Dict[str, str]
Standardwert: None

Ein optionales Wörterbuch von Pipeline-Parameterzuweisungen für den PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt.

continue_on_step_failure
bool
Standardwert: None

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.

tags
Dict[str, str]
Standardwert: None

Ein optionales Tagwörterbuch für den PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt.

properties
Dict[str, str]
Standardwert: None

Ein optionales Eigenschaftenwörterbuch für den PipelineDraft; wird nur beim Erstellen auf Grundlage einer Pipeline benötigt.

_service_endpoint
str
Standardwert: None

Der Dienstendpunkt.

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

(Nur interne Verwendung.) Der Workflowanbieter.

Gibt zurück

Der erstellte PipelineDraft.

Rückgabetyp

delete

Löschen Sie den PipelineDraft.

delete(_workflow_provider=None)

Parameter

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

(Nur interne Verwendung.) Der Workflowanbieter.

get

Rufen Sie den PipelineDraft mit der angegebenen ID ab.

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

Parameter

workspace
Workspace
Erforderlich

Der Arbeitsbereich, in dem der PipelineDraft erstellt wurde.

id
str
Erforderlich

Rufen Sie die ID des PipelineDraft ab.

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

(Nur interne Verwendung.) Der Workflowanbieter.

_service_endpoint
str
Standardwert: None

Der Dienstendpunkt.

Gibt zurück

PipelineDraft-Objekt

Rückgabetyp

get_graph

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

get_graph(_workflow_provider=None)

Parameter

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

(Nur interne Verwendung.) Der Workflowanbieter.

Gibt zurück

Das Graph-Objekt.

Rückgabetyp

list

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

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

Parameter

workspace
Workspace
Erforderlich

Der Arbeitsbereich, aus dem Entwürfe aufgeführt werden sollen.

tags
dict
Standardwert: None

Wenn angegeben, werden Entwürfe zurückgegeben, die mit dem angegebenen {"tag": "value"} übereinstimmen.

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

(Nur interne Verwendung.) Der Workflowanbieter.

Gibt zurück

Eine Liste von PipelineDraft-Objekten.

Rückgabetyp

publish

Veröffentlichen Sie eine PublishedPipeline aus dem PipelineDraft.

publish(_workflow_provider=None)

Parameter

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

(Nur interne Verwendung.) Der Workflowanbieter.

Gibt zurück

Die erstellte PublishedPipeline.

Rückgabetyp

save

Speichern Sie die PipelineDraft-YAML in einer Datei.

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 PipelineDraft-YAML-Datei unter path/pipeline_name.yml gespeichert. Bei „None“ wird das aktuelle Verzeichnis verwendet.

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

(Nur interne Verwendung.) Der Workflowanbieter.

Rückgabetyp

submit_run

Übermitteln Sie eine PipelineRun aus dem PipelineDraft.

submit_run(_workflow_provider=None)

Parameter

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

(Nur interne Verwendung.) Der Workflowanbieter.

Gibt zurück

Die übermittelte PipelineRun.

Rückgabetyp

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

pipeline
Pipeline
Standardwert: None

Die aktualisierte Pipeline für den Entwurf.

name
str
Standardwert: None

Der Name des PipelineDraft.

description
str
Standardwert: None

Die Beschreibung des PipelineDraft.

experiment_name
str
Standardwert: None

Der Experimentname für den PipelineDraft.

tags
Dict[str, str]
Standardwert: None

Ein Tagwörterbuch für den PipelineDraft.

pipeline_parameters
Dict[str, str]
Standardwert: None

Die Pipeline-Parameterzuweisungen für den PipelineDraft.

continue_on_step_failure
bool
Standardwert: None

Gibt an, ob die PipelineRun fortgesetzt werden soll, wenn bei einer Schrittausführung für den PipelineDraft ein Fehler auftritt.

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

(Nur interne Verwendung.) Der Workflowanbieter.

Attribute

description

Rufen Sie die Beschreibung des PipelineDraft ab.

Gibt zurück

Die Beschreibungszeichenfolge.

Rückgabetyp

str

id

Rufen Sie die ID des PipelineDraft ab.

Gibt zurück

Die ID.

Rückgabetyp

str

last_submitted_pipeline_run_id

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

Gibt zurück

Die PipelineRun-ID.

Rückgabetyp

str

name

Rufen Sie den Namen des PipelineDraft ab.

Gibt zurück

Der Name.

Rückgabetyp

str

parent_pipeline_draft_id

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

Gibt zurück

Die PipelineDraft-ID.

Rückgabetyp

str

parent_pipeline_id

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

Gibt zurück

Die PublishedPipeline-ID.

Rückgabetyp

str

parent_pipeline_run_id

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

Gibt zurück

Die PipelineRun-ID.

Rückgabetyp

str

parent_step_run_ids

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

Gibt zurück

Eine Liste der StepRun-IDs.

Rückgabetyp

properties

Rufen Sie die Eigenschaften des PipelineDraft ab.

Gibt zurück

Das Eigenschaftenwörterbuch.

Rückgabetyp

tags

Rufen Sie die Tags des PipelineDraft ab.

Gibt zurück

Das Tagwörterbuch.

Rückgabetyp