PipelineRun Klass

Referens

Representerar en körning av en Pipeline.

Den här klassen kan användas för att hantera, kontrollera status och hämta körningsinformation när en pipelinekörning har skickats. Använd get_steps för att hämta de StepRun objekt som skapas av pipelinekörningen. Andra användningsområden är att hämta objektet Graph som är associerat med pipelinekörningen, hämta status för pipelinekörningen och vänta på att körningen ska slutföras.

Initiera en pipelinekörning.

Arv: Run

PipelineRun

Konstruktor

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

Parametrar

Name	Description
experiment Obligatorisk	Experiment Experimentobjektet som är associerat med pipelinekörningen.
run_id Obligatorisk	str Körnings-ID för pipelinekörningen.
_service_endpoint	str Slutpunkten att ansluta till. Standardvärde: None
experiment Obligatorisk	Experiment Experimentobjektet som är associerat med pipelinekörningen.
run_id Obligatorisk	str Körnings-ID för pipelinekörningen.
_service_endpoint Obligatorisk	str Slutpunkten att ansluta till.

Kommentarer

Ett PipelineRun-objekt returneras när du skickar ett Pipeline via submit. -metod för en Experiment. Mer information om hur du skapar och skickar en pipeline finns i: https://aka.ms/pl-first-pipeline.

En PipelineRun kan också instansieras med körningen Experiment som skickades till och PipelineRun-ID:t på följande sätt:


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

När du arbetar med PipelineRun-användning:

wait_for_completion för att övervaka körningsstatusen och eventuellt strömma körningsloggar.
get_status för att hämta körningsstatusen.
cancel för att avbryta en pågående PipelineRun.
get_steps för att lista de genererade StepRuns. En PipelineRun genererar en StepRun för varje steg i pipelinen.

Metoder

cancel	Avbryt den pågående körningen.
child_run	Skapa en underordnad körning för pipelinekörningen. Den här metoden implementeras inte för PipelineRun.
complete	Markera pipelinekörningen som slutförd. Den här metoden implementeras inte för PipelineRun. Den här metoden stöds inte för pipelines. slutförande/misslyckad status hanteras av Azure ML-serverdelen.
fail	Markera pipelinekörningen som misslyckad. Den här metoden implementeras inte för PipelineRun. Den här metoden stöds inte för pipelines. slutförande/misslyckad status hanteras av Azure ML-serverdelen.
find_step_run	Hitta en stegkörning i pipelinen efter namn.
get	Hämta en pipelinekörning baserat på ett körnings-ID.
get_graph	Hämta diagrammet för pipelinekörningen.
get_pipeline_output	Hämta PortDataReference för angivna pipelineutdata.
get_pipeline_runs	Hämta pipelinekörningarna som genererades från en publicerad pipeline.
get_status	Hämta pipelinekörningens senaste status från tjänsten. Vanliga värden som returneras är "Running", "Finished" och "Failed".
get_steps	Hämta stegkörningarna för alla pipelinesteg som har slutförts eller börjat köras.
get_tags	Hämta uppsättningen taggar för körningen.
publish_pipeline	Publicera en pipeline och gör den tillgänglig för omkörning. Du kan hämta pipelineslutpunkten från objektet PublishedPipeline som returneras av den här funktionen. Med pipelineslutpunkten kan du anropa pipelinen från externa program med hjälp av REST-anrop. Information om hur du autentiserar när du anropar REST-slutpunkter finns i https://aka.ms/pl-restep-auth. Den ursprungliga pipelinen som är associerad med pipelinekörningen används som bas för den publicerade pipelinen.
save	Spara YAML-pipelinen i en fil.
wait_for_completion	Vänta tills pipelinekörningen har slutförts. Returnerar statusen efter väntetiden.

cancel

Avbryt den pågående körningen.

cancel()

child_run

Skapa en underordnad körning för pipelinekörningen. Den här metoden implementeras inte för PipelineRun.

child_run(name=None, run_id=None, outputs=None)

Parametrar

Name	Description
name	str Valfritt namn för den underordnade. Standardvärde: None
run_id	str Valfritt körnings-ID för det underordnade, annars används standard. Standardvärde: None
outputs	str Valfri utdatakatalog som ska spåras för den underordnade. Standardvärde: None

Returer

Typ	Description
Run	Den underordnade körningen.

Undantag

Typ	Description
NotImplementedError

complete

Markera pipelinekörningen som slutförd. Den här metoden implementeras inte för PipelineRun.

Den här metoden stöds inte för pipelines. slutförande/misslyckad status hanteras av Azure ML-serverdelen.

complete()

Undantag

Typ	Description
NotImplementedError

fail

Markera pipelinekörningen som misslyckad. Den här metoden implementeras inte för PipelineRun.

Den här metoden stöds inte för pipelines. slutförande/misslyckad status hanteras av Azure ML-serverdelen.

fail()

Undantag

Typ	Description
NotImplementedError

find_step_run

Hitta en stegkörning i pipelinen efter namn.

find_step_run(name)

Parametrar

Name	Description
name Obligatorisk	str Namnet på det steg som ska hittas.

Returer

Typ	Description
list	StepRun Lista över objekt med det angivna namnet.

get

Hämta en pipelinekörning baserat på ett körnings-ID.

static get(workspace, run_id, _service_endpoint=None)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan som är associerad med pipelinen.
run_id Obligatorisk	str ID:t för pipelinekörningen.
_service_endpoint	str Slutpunkten att ansluta till. Standardvärde: None

Returer

Typ	Description
PipelineRun	Objektet PipelineRun .

get_graph

Hämta diagrammet för pipelinekörningen.

get_graph()

Returer

Typ	Description
Graph	Diagrammet.

get_pipeline_output

Hämta PortDataReference för angivna pipelineutdata.

get_pipeline_output(pipeline_output_name)

Parametrar

Name	Description
pipeline_output_name Obligatorisk	str Namnet på pipelineutdata som ska hämtas.

Returer

Typ	Description
PortDataReference	PortDataReference som representerar pipelinens utdata.

get_pipeline_runs

Hämta pipelinekörningarna som genererades från en publicerad pipeline.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan som är associerad med pipelinen.
pipeline_id Obligatorisk	str ID för den publicerade pipelinen.
_service_endpoint	str Slutpunkten att ansluta till. Standardvärde: None

Returer

Typ	Description
list	En lista över PipelineRun objekt.

get_status

Hämta pipelinekörningens senaste status från tjänsten.

Vanliga värden som returneras är "Running", "Finished" och "Failed".

get_status()

Returer

Typ	Description
str	Den senaste statusen som en sträng.

Kommentarer

NotStarted – det här är ett tillfälligt tillstånd för körningsobjekt på klientsidan innan molnöverföring
Körs – jobbet började köras i beräkningsmålet.
Misslyckades – körningen misslyckades. Vanligtvis innehåller egenskapen Error på en körning information om varför.
Slutförd – körningen slutfördes.
Avbruten – Efter en annulleringsbegäran avbryts körningen nu.


   run = experiment.submit(config)
   while run.get_status() not in ['Finished', 'Failed']: # For example purposes only, not exhaustive
       print('Run {} not in terminal state'.format(run.id))
       time.sleep(10)

get_steps

Hämta stegkörningarna för alla pipelinesteg som har slutförts eller börjat köras.

get_steps()

Returer

Typ	Description
list	En lista över StepRun objekt.

get_tags

Hämta uppsättningen taggar för körningen.

get_tags()

Returer

Typ	Description
dict	Ordlistan med taggar för körningen.

publish_pipeline

Publicera en pipeline och gör den tillgänglig för omkörning.

Du kan hämta pipelineslutpunkten från objektet PublishedPipeline som returneras av den här funktionen. Med pipelineslutpunkten kan du anropa pipelinen från externa program med hjälp av REST-anrop. Information om hur du autentiserar när du anropar REST-slutpunkter finns i https://aka.ms/pl-restep-auth.

Den ursprungliga pipelinen som är associerad med pipelinekörningen används som bas för den publicerade pipelinen.

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

Parametrar

Name	Description
name Obligatorisk	str Namnet på den publicerade pipelinen.
description Obligatorisk	str Beskrivningen av den publicerade pipelinen.
version Obligatorisk	str Versionen av den publicerade pipelinen.
continue_on_step_failure	bool Om du vill fortsätta körningen av andra steg i PipelineRun om ett steg misslyckas. Standardvärdet är Falskt. Standardvärde: None
kwargs Obligatorisk	dict Anpassade nyckelordsargument, reserverade för framtida utveckling

Returer

Typ	Description
PublishedPipeline	Skapad publicerad pipeline.

save

Spara YAML-pipelinen i en fil.

save(path=None)

Parametrar

Name	Description
path	str Sökvägen för att spara YAML till. Om sökvägen är en katalog sparas YAML-pipelinefilen på <path>/pipeline.yml. Om sökvägen inte är någon används den aktuella katalogen. Standardvärde: None

Returer

Typ	Description
None

wait_for_completion

Vänta tills pipelinekörningen har slutförts.

Returnerar statusen efter väntetiden.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

Parametrar

Name	Description
show_output	bool Anger om pipelinekörningsstatus ska visas på sys.stdout. Standardvärde: True
timeout_seconds	int Antal sekunder att vänta innan tidsgränsen är slut. Standardvärde: 9223372036854775807
raise_on_error	bool Anger om ett fel ska uppstå när körningen är i ett feltillstånd. Standardvärde: True

Returer

Typ	Description
str	Den slutliga statusen.

Dela via

PipelineRun Klass

Konstruktor

Parametrar

Kommentarer

Metoder

cancel

child_run

Parametrar

Returer

Undantag

complete

Undantag

fail

Undantag

find_step_run

Parametrar

Returer

get

Parametrar

Returer

get_graph

Returer

get_pipeline_output

Parametrar

Returer

get_pipeline_runs

Parametrar

Returer

get_status

Returer

Kommentarer

get_steps

Returer

get_tags

Returer

publish_pipeline

Parametrar

Returer

save

Parametrar

Returer

wait_for_completion

Parametrar

Returer

Feedback

Ytterligare resurser