PipelineRun Klass

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

experiment

Experiment

Obligatorisk

Experimentobjektet som är associerat med pipelinekörningen.

run_id

str

Obligatorisk

Körnings-ID för pipelinekörningen.

_service_endpoint

str

standardvärde: None

Slutpunkten att ansluta till.

experiment

Experiment

Obligatorisk

Experimentobjektet som är associerat med pipelinekörningen.

run_id

str

Obligatorisk

Körnings-ID för pipelinekörningen.

_service_endpoint

str

Obligatorisk

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

str

standardvärde: None

Valfritt namn för den underordnade.

run_id

str

standardvärde: None

Valfritt körnings-ID för det underordnade, annars används standard.

outputs

str

standardvärde: None

Valfri utdatakatalog som ska spåras för den underordnade.

Returer

Den underordnade körningen.

Returtyp

Run

Undantag

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

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

NotImplementedError

find_step_run

Hitta en stegkörning i pipelinen efter namn.

find_step_run(name)

Parametrar

name

str

Obligatorisk

Namnet på det steg som ska hittas.

Returer

StepRun Lista över objekt med det angivna namnet.

Returtyp

list

get

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

static get(workspace, run_id, _service_endpoint=None)

Parametrar

workspace

Workspace

Obligatorisk

Arbetsytan som är associerad med pipelinen.

run_id

str

Obligatorisk

ID:t för pipelinekörningen.

_service_endpoint

str

standardvärde: None

Slutpunkten att ansluta till.

Returer

Objektet PipelineRun .

Returtyp

PipelineRun

get_graph

Hämta diagrammet för pipelinekörningen.

get_graph()

Returer

Diagrammet.

Returtyp

Graph

get_pipeline_output

Hämta PortDataReference för angivna pipelineutdata.

get_pipeline_output(pipeline_output_name)

Parametrar

pipeline_output_name

str

Obligatorisk

Namnet på pipelineutdata som ska hämtas.

Returer

PortDataReference som representerar pipelinens utdata.

Returtyp

PortDataReference

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

workspace

Workspace

Obligatorisk

Arbetsytan som är associerad med pipelinen.

pipeline_id

str

Obligatorisk

ID för den publicerade pipelinen.

_service_endpoint

str

standardvärde: None

Slutpunkten att ansluta till.

Returer

En lista över PipelineRun objekt.

Returtyp

list

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

Den senaste statusen som en sträng.

Returtyp

str

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

En lista över StepRun objekt.

Returtyp

list

get_tags

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

get_tags()

Returer

Ordlistan med taggar för körningen.

Returtyp

dict

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

str

Obligatorisk

Namnet på den publicerade pipelinen.

description

str

Obligatorisk

Beskrivningen av den publicerade pipelinen.

version

str

Obligatorisk

Versionen av den publicerade pipelinen.

continue_on_step_failure

bool

standardvärde: None

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

kwargs

dict

Obligatorisk

Anpassade nyckelordsargument, reserverade för framtida utveckling

Returer

Skapad publicerad pipeline.

Returtyp

PublishedPipeline

save

Spara YAML-pipelinen i en fil.

save(path=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.yml. Om sökvägen inte är någon används den aktuella katalogen.

Returtyp

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

show_output

bool

standardvärde: True

Anger om pipelinekörningsstatus ska visas på sys.stdout.

timeout_seconds

int

standardvärde: 9223372036854775807

Antal sekunder att vänta innan tidsgränsen är slut.

raise_on_error

bool

standardvärde: True

Anger om ett fel ska uppstå när körningen är i ett feltillstånd.

Returer

Den slutliga statusen.

Returtyp

str