PublishedPipeline Klass

  • Referens

Representerar en pipeline som ska skickas utan Den Python-kod som skapade den.

Dessutom kan en PublishedPipeline användas för att skicka om en Pipeline med olika PipelineParameter värden och indata.

Initiera PublishedPipeline.

:p ramslutpunkt REST-slutpunktens URL för att skicka pipelinekörningar för den här pipelinen. :type endpoint: str :p aram total_run_steps: Antalet steg i den här pipelinen :type total_run_steps: int :p aram workspace: Arbetsytan för den publicerade pipelinen. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: Om du vill fortsätta köra andra steg i PipelineRun

Om ett steg misslyckas är standardvärdet falskt.

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

Parametrar

name
str
Obligatorisk

Namnet på den publicerade pipelinen.

graph_id
str
Obligatorisk

ID för grafen för den publicerade pipelinen.

description
str
Obligatorisk

Beskrivningen av den publicerade pipelinen.

version
str
Obligatorisk

Den publicerade pipelineversionen.

published_pipeline_id
str
Obligatorisk

ID för den publicerade pipelinen.

status
str
Obligatorisk

Status för den publicerade pipelinen ("Aktiv" eller "Inaktiverad").

endpoint
str
Obligatorisk

REST-slutpunkts-URL:en för att skicka körningar för den här pipelinen.

total_run_steps
int
Obligatorisk

Antalet steg i den här pipelinen.

workspace
Workspace
Obligatorisk

Arbetsytan för den publicerade pipelinen.

continue_on_step_failure
bool
Obligatorisk

Om du vill fortsätta körningen av andra steg i PipelineRun om ett steg misslyckas. Standardvärdet är False.

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

Den publicerade pipelineprovidern.

kwargs
dict
Obligatorisk

Anpassade nyckelordsargument, reserverade för framtida utveckling

name
str
Obligatorisk

Namnet på den publicerade pipelinen.

graph_id
str
Obligatorisk

ID för grafen för den publicerade pipelinen.

description
str
Obligatorisk

Beskrivningen av den publicerade pipelinen.

version
str
Obligatorisk

Den publicerade pipelineversionen.

published_pipeline_id
str
Obligatorisk

ID för den publicerade pipelinen.

status
str
Obligatorisk

Status för den publicerade pipelinen ("Aktiv" eller "Inaktiverad").

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

Den publicerade pipelineprovidern.

kwargs
dict
Obligatorisk

Anpassade nyckelordsargument, reserverade för framtida utveckling

Kommentarer

En PublishedPipeline kan skapas från antingen en Pipeline eller en PipelineRun.

Ett exempel på publicering från en pipeline är följande:


   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)

Så här publicerar du från en PipelineKör:


   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)

Obs! parametern continue_on_step_failure anger om körningen av stegen i pipelinen fortsätter om ett steg misslyckas. Standardvärdet är False, vilket innebär att när ett steg misslyckas stoppas pipelinekörningen och alla pågående steg avbryts.

Skicka en PublishedPipeline med hjälp av submit. När skicka anropas skapas en PipelineRun som i sin tur skapar StepRun objekt för varje steg i arbetsflödet.

Ett exempel på hur du skickar en PublishedPipeline är följande:


   from azureml.pipeline.core import PublishedPipeline

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

Det finns ett antal valfria inställningar som kan anges när du skickar en PublishedPipeline. Dessa omfattar:

  • continue_on_step_failure: Om du vill fortsätta att köra andra steg i PipelineRun om ett steg misslyckas, valfritt. Endast steg som inte är beroende av utdata från det misslyckade steget fortsätter körningen. Om den här parameterinställningen anges åsidosätter den inställningen för pipelinen.

  • pipeline_parameters: Parametrar för pipelinekörning, ordlista med {name: value}. Mer PipelineParameter information finns i.

  • parent_run_id: Du kan ange ett körnings-ID för att ange den överordnade körningen av den här pipelinekörningen, vilket visas i RunHistory. Den överordnade körningen måste tillhöra samma experiment som pipelinen som skickas.

Ett exempel på hur du skickar en PublishedPipeline med de här inställningarna är följande:


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

Alla publicerade pipelines har en REST-slutpunkt. Med pipelineslutpunkten kan du utlösa en körning av pipelinen från externa system, till exempel icke-Python-klienter. Information om hur du autentiserar när du anropar REST-slutpunkter finns i https://aka.ms/pl-restep-auth.

Med hjälp av slutpunkten aktiveras till exempel "hanterad repeterbarhet" i scenarier med batchbedömning och omträning. Mer information finns i https://aka.ms/pl-first-pipeline.

Metoder

disable

Ange den publicerade pipelinen till "Inaktiverad" och otillgänglig för körning.
enable

Ange den publicerade pipelinen till "Aktiv" och tillgänglig för körning.
get

Hämta den publicerade pipelinen.
get_all

Hämta alla publicerade pipelines på den aktuella arbetsytan.

INAKTUELL: Den här metoden håller på att bli inaktuell till förmån för metoden PublishedPipeline list .
get_graph

Hämta grafen för PublishedPipeline.
get_step_names

Hämta listan med namn på steg i PublishedPipeline.
list

Hämta alla publicerade pipelines på den aktuella arbetsytan.
save

Spara PIPELINE-YAML i en fil.

För närvarande stöds endast pipelines som består av ModuleSteps för YAML-export.
submit

Skicka den publicerade pipelinen. Detta motsvarar att använda submit.

Returnerar den skickade PipelineRun. Använd det här objektet för att övervaka och visa information om körningen.

disable

Ange den publicerade pipelinen till "Inaktiverad" och otillgänglig för körning.

disable()

enable

Ange den publicerade pipelinen till "Aktiv" och tillgänglig för körning.

enable()

get

Hämta den publicerade pipelinen.

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

Parametrar

workspace
Workspace
Obligatorisk

Arbetsytan som den publicerade pipelinen skapades i.

id
str
Obligatorisk

ID för den publicerade pipelinen.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
standardvärde: None

Arbetsflödesprovidern.

_service_endpoint
str
standardvärde: None

Tjänstslutpunkten.

Returer

Ett PublishedPipeline-objekt.

Returtyp

PublishedPipeline

get_all

Hämta alla publicerade pipelines på den aktuella arbetsytan.

INAKTUELL: Den här metoden håller på att bli inaktuell till förmån för metoden PublishedPipeline list .

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

Parametrar

workspace
Workspace
Obligatorisk

Arbetsytan som den publicerade pipelinen skapades på.

active_only
bool
standardvärde: True

Om endast publicerade pipelines som är aktiva ska returneras.

_service_endpoint
str
standardvärde: None

Tjänstslutpunkten.

Returer

En lista över PublishedPipeline-objekt.

Returtyp

list[PublishedPipeline]

get_graph

Hämta grafen för PublishedPipeline.

get_graph(_workflow_provider=None)

Parametrar

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
standardvärde: None

Arbetsflödesprovidern.

Returer

Diagrammet.

Returtyp

Graph

get_step_names

Hämta listan med namn på steg i PublishedPipeline.

get_step_names(_workflow_provider=None)

Parametrar

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
standardvärde: None

Arbetsflödesprovidern.

Returer

Listan över namnen på stegen i PublishedPipeline.

Returtyp

List[str]

list

Hämta alla publicerade pipelines på den aktuella arbetsytan.

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

Parametrar

workspace
Workspace
Obligatorisk

Arbetsytan som den publicerade pipelinen skapades i.

active_only
bool
standardvärde: True

Om endast publicerade pipelines som är aktiva ska returneras.

_service_endpoint
str
standardvärde: None

Tjänstslutpunkten.

Returer

En lista över PublishedPipeline-objekt.

Returtyp

list[PublishedPipeline]

save

Spara PIPELINE-YAML i en fil.

För närvarande stöds endast pipelines som består av ModuleSteps för YAML-export.

save(path=None, _workflow_provider=None)

Parametrar

path
str
standardvärde: None

Sökvägen för att spara YAML till. Om sökvägen är en katalog sparas YAML-pipelinefilen på path/pipeline_name.yml. Om sökvägen är Ingen används den aktuella katalogen.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
standardvärde: None

Arbetsflödesprovidern.

Returtyp

None

submit

Skicka den publicerade pipelinen. Detta motsvarar att använda submit.

Returnerar den skickade PipelineRun. Använd det här objektet för att övervaka och visa information om körningen.

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

Parametrar

workspace
Workspace
Obligatorisk

Arbetsytan som den publicerade pipelinen ska skickas på.

experiment_name
str
Obligatorisk

Namnet på experimentet som ska skickas till.

pipeline_parameters
dict
standardvärde: None

En ordlista med parametrar för att tilldela nya värden {param name, param value}. Mer PipelineParameter information finns i.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
standardvärde: None

Arbetsflödesprovidern.

_service_endpoint
str
standardvärde: None

Tjänstslutpunkten.

parent_run_id
str
standardvärde: None

Valfritt körnings-ID som ska anges för den överordnade körningen av den här pipelinekörningen, vilket återspeglas i RunHistory. Den överordnade körningen måste tillhöra samma experiment som den här pipelinen skickas till.

continue_on_step_failure
bool
standardvärde: None

Om du vill fortsätta köra andra steg i PipelineRun om ett steg misslyckas, valfritt. Om detta anges åsidosätter inställningen för pipelinen.

Returer

Den skickade pipelinekörningen.

Returtyp

PipelineRun

Attribut

continue_on_step_failure

Hämta värdet för inställningen continue_on_step_failure .

Returer

Värdet för inställningen continue_on_step_failure .

Returtyp

bool

description

Hämta beskrivningen av den publicerade pipelinen.

Returer

Beskrivningen av den publicerade pipelinen.

Returtyp

str

endpoint

Hämta REST-slutpunkts-URL:en för att köra en publicerad pipeline.

Returer

REST-slutpunkts-URL:en för att köra den publicerade pipelinen.

Returtyp

str

graph_id

Hämta ID:t för grafen för den här publicerade pipelinen.

Returer

Diagrammets ID.

Returtyp

str

id

Hämta det publicerade pipeline-ID:t.

Returer

ID för den publicerade pipelinen.

Returtyp

str

name

Hämta namnet på den publicerade pipelinen.

Returer

Det publicerade pipelinenamnet.

Returtyp

str

status

Hämta status för den publicerade pipelinen.

Returer

Status för den publicerade pipelinen.

Returtyp

str

total_run_steps

Hämta antalet steg i pipelinen.

Returer

Antalet steg i pipelinen.

Returtyp

int

version

Hämta versionen av den publicerade pipelinen.

Returer

Versionen av den publicerade pipelinen.

Returtyp

str