PipelineDraft Klass

Referens

Representerar en föränderlig pipeline som kan användas för att skicka körningar och skapa publicerade pipelines.

Använd PipelineDrafts för att iterera i pipelines. PipelineDrafts kan skapas från grunden, en annan PipelineDraft eller befintliga pipelines: Pipeline, PublishedPipelineeller PipelineRun.

Initiera PipelineDraft.

Arv: 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)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsyteobjektet för denna PipelineDraft.
id Obligatorisk	str ID för PipelineDraft.
name Obligatorisk	str Namnet på PipelineDraft.
description Obligatorisk	str Beskrivningen av PipelineDraft.
experiment_name Obligatorisk	str Experimentnamnet för PipelineDraft.
tags Obligatorisk	Dict[str, str] En valfri ordlista för taggar för PipelineDraft.
properties Obligatorisk	Dict[str, str] En valfri egenskapsordlista för PipelineDraft.
graph_draft_id Obligatorisk	str ID:t för grafutkastet som är associerat med PipelineDraft.
parent_pipeline_id Obligatorisk	str ID för den överordnade PublishedPipeline.
parent_pipeline_run_id Obligatorisk	str ID för den överordnade PipelineRun.
parent_step_run_ids Obligatorisk	list En lista över StepRun-ID:t för den överordnade PipelineRun.
parent_pipeline_draft_id Obligatorisk	str ID för den överordnade PipelineDraft.
last_submitted_pipeline_run_id Obligatorisk	str ID:t för den senast skickade PipelineRun.
_pipeline_draft_provider Obligatorisk	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> (Endast internt bruk.) PipelineDraft-providern.
workspace Obligatorisk	Workspace Arbetsyteobjekt för denna PipelineDraft.
id Obligatorisk	str ID för PipelineDraft.
name Obligatorisk	str Namnet på PipelineDraft.
description Obligatorisk	str Beskrivningen av PipelineDraft.
experiment_name Obligatorisk	str Experimentnamnet för PipelineDraft.
tags Obligatorisk	Dict[str, str] Ordlista för taggar för PipelineDraft.
properties Obligatorisk	Dict[str, str] Egenskapsordlista för PipelineDraft.
graph_draft_id Obligatorisk	str ID:t för grafutkastet som är associerat med PipelineDraft.
parent_pipeline_id Obligatorisk	str ID:t för den överordnade PublishedPipeline.
parent_pipeline_run_id Obligatorisk	str ID:t för den överordnade PipelineRun.
parent_step_run_ids Obligatorisk	list En lista över StepRun-ID:t för den överordnade PipelineRun.
parent_pipeline_draft_id Obligatorisk	str ID:t för den överordnade PipelineDraft.
last_submitted_pipeline_run_id Obligatorisk	str ID:t för den senast skickade PipelineRun.
_pipeline_draft_provider Obligatorisk	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> PipelineDraft-providern.

Kommentarer

En PipelineDraft kan skapas från en Pipeline med hjälp create av funktionen . Nedan visas ett exempel:


   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'})

PipelineDraft.create()-pipelineparametern kan också vara en PublishedPipeline, PipelineRuneller en annan PipelineDraft.

Om du vill skicka en körning från en PipelineDraft använder du submit_run metoden:


   pipeline_run = pipeline_draft.submit_run()

Om du vill uppdatera en PipelineDraft använder du update metoden . Funktionen update() för ett pipeline-utkast kan användas för att uppdatera namn, beskrivning, experimentnamn, tilldelningar av pipelineparametrar, fortsätta med felinställningen för steg och Pipeline som är associerad med PipelineDraft.


   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)

Metoder

create	Skapa en PipelineDraft.
delete	Ta bort PipelineDraft.
get	Hämta PipelineDraft med angivet ID.
get_graph	Hämta grafen som är associerad med PipelineDraft.
list	Hämta alla pipeline-utkast på en arbetsyta.
publish	Publicera en PublishedPipeline från PipelineDraft.
save	Spara PipelineDraft YAML i en fil.
submit_run	Skicka en PipelineRun från PipelineDraft.
update	Uppdatera en PipelineDraft. De angivna fälten uppdateras.

create

Skapa en 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)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsyteobjektet som pipelineDraft kommer att tillhöra.
pipeline Obligatorisk	PublishedPipeline eller Pipeline eller PipelineRun eller PipelineDraft Den publicerade pipelinen eller pipelinen.
name	str Namnet på PipelineDraft; behövs bara när du skapar från en Pipeline. Standardvärde: None
description	str Beskrivningen av PipelineDraft; behövs bara när du skapar från en Pipeline. Standardvärde: None
experiment_name	str Experimentnamnet för PipelineDraft; behövs bara när du skapar från en Pipeline. Standardvärde: None
pipeline_parameters	Dict[str, str] En valfri ordlista över pipelineparametertilldelningar för PipelineDraft; behövs bara när du skapar från en Pipeline. Standardvärde: None
continue_on_step_failure	bool Anger om du vill fortsätta med en PipelineRun när en stegkörning misslyckas för PipelineDraft; behövs bara när du skapar från en Pipeline. Standardvärde: None
tags	Dict[str, str] En valfri ordlista för taggar för PipelineDraft behövs bara när du skapar från en Pipeline. Standardvärde: None
properties	Dict[str, str] Valfri egenskapsordlista för PipelineDraft, behövs bara när du skapar från en Pipeline. Standardvärde: None
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Endast internt bruk.) Arbetsflödesprovidern. Standardvärde: None

Returer

Typ	Description
PipelineDraft	Den skapade PipelineDraft.

delete

Ta bort PipelineDraft.

delete(_workflow_provider=None)

Parametrar

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Endast internt bruk.) Arbetsflödesprovidern. Standardvärde: None

get

Hämta PipelineDraft med angivet ID.

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

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan som PipelineDraft skapades i.
id Obligatorisk	str ID för PipelineDraft.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Endast internt bruk.) Arbetsflödesprovidern. Standardvärde: None
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None

Returer

Typ	Description
PipelineDraft	PipelineDraft-objekt

get_graph

Hämta grafen som är associerad med PipelineDraft.

get_graph(_workflow_provider=None)

Parametrar

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Endast internt bruk.) Arbetsflödesprovidern. Standardvärde: None

Returer

Typ	Description
Graph	Graph-objektet.

list

Hämta alla pipeline-utkast på en arbetsyta.

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

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan som utkast ska listas från.
tags	dict Om det anges returneras utkast som matchar angiven {"tagg": "value"}. Standardvärde: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Endast internt bruk.) Arbetsflödesprovidern. Standardvärde: None

Returer

Typ	Description
list	En lista över PipelineDraft objekt.

publish

Publicera en PublishedPipeline från PipelineDraft.

publish(_workflow_provider=None)

Parametrar

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Endast internt bruk.) Arbetsflödesprovidern. Standardvärde: None

Returer

Typ	Description
PublishedPipeline	Den skapade PublishedPipeline.

save

Spara PipelineDraft YAML i en fil.

save(path=None, _workflow_provider=None)

Parametrar

Name	Description
path	str Sökvägen för att spara YAML till. Om sökvägen är en katalog sparas YAML-filen PipelineDraft på path/pipeline_name.yml. Om sökvägen är Ingen används den aktuella katalogen. Standardvärde: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Endast internt bruk.) Arbetsflödesprovidern. Standardvärde: None

Returer

Typ	Description
None

submit_run

Skicka en PipelineRun från PipelineDraft.

submit_run(_workflow_provider=None)

Parametrar

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Endast internt bruk.) Arbetsflödesprovidern. Standardvärde: None

Returer

Typ	Description
PipelineRun	Den skickade PipelineRun.

update

Uppdatera en PipelineDraft.

De angivna fälten uppdateras.

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

Parametrar

Name	Description
pipeline	Pipeline Den uppdaterade pipelinen för utkastet. Standardvärde: None
name	str Namnet på PipelineDraft. Standardvärde: None
description	str Beskrivningen av PipelineDraft. Standardvärde: None
experiment_name	str Experimentnamnet för PipelineDraft. Standardvärde: None
tags	Dict[str, str] En ordlista för taggar för PipelineDraft. Standardvärde: None
pipeline_parameters	Dict[str, str] Pipelineparametertilldelningarna för PipelineDraft. Standardvärde: None
continue_on_step_failure	bool Om du vill fortsätta PipelineRun när en stegkörning misslyckas för PipelineDraft. Standardvärde: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Endast internt bruk.) Arbetsflödesprovidern. Standardvärde: None

Attribut

description

Hämta beskrivningen av PipelineDraft.

Returer

Typ	Description
str	Beskrivningssträngen.

id

Hämta ID:t för PipelineDraft.

Returer

Typ	Description
str	ID:t.

last_submitted_pipeline_run_id

Hämta ID:t för den senast skickade PipelineRun för PipelineDraft.

Returer

Typ	Description
str	PipelineKör ID.

name

Ange namnet på PipelineDraft.

Returer

Typ	Description
str	Namnet.

parent_pipeline_draft_id

Hämta ID:t för den överordnade PipelineDraft för PipelineDraft.

Returer

Typ	Description
str	PipelineDraft-ID: t.

parent_pipeline_id

Hämta ID:t för den överordnade PublishedPipeline för PipelineDraft.

Returer

Typ	Description
str	ID:t PublishedPipeline.

parent_pipeline_run_id

Hämta ID:t för den överordnade PipelineRun för PipelineDraft.

Returer

Typ	Description
str	PipelineKör ID.

parent_step_run_ids

Hämta listan över StepRun-ID:t för den överordnade PipelineRun för PipelineDraft.

Returer

Typ	Description
list	En lista över StepRun-ID:t.

properties

Hämta egenskaperna för PipelineDraft.

Returer

Typ	Description
dict	Egenskapsordlistan.

Dela via

PipelineDraft Klass

Konstruktor

Parametrar

Kommentarer

Metoder

create

Parametrar

Returer

delete

Parametrar

get

Parametrar

Returer

get_graph

Parametrar

Returer

list

Parametrar

Returer

publish

Parametrar

Returer

save

Parametrar

Returer

submit_run

Parametrar

Returer

update

Parametrar

Attribut

description

Returer

id

Returer

last_submitted_pipeline_run_id

Returer

name

Returer

parent_pipeline_draft_id

Returer

parent_pipeline_id

Returer

parent_pipeline_run_id

Returer

parent_step_run_ids

Returer

properties

Returer

tags

Returer

Feedback

Ytterligare resurser