PipelineRun Třída

Reference

Představuje spuštění objektu Pipeline.

Tuto třídu je možné použít ke správě, kontrole stavu a načítání podrobností o spuštění po odeslání spuštění kanálu. Slouží get_steps k načtení StepRun objektů vytvořených spuštěním kanálu. Mezi další použití patří načtení objektu přidruženého Graph ke spuštění kanálu, načtení stavu spuštění kanálu a čekání na dokončení spuštění.

Inicializace spuštění kanálu

Dědičnost: Run

PipelineRun

Konstruktor

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

Parametry

Name	Description
experiment Vyžadováno	Experiment Objekt experimentu přidružený ke spuštění kanálu.
run_id Vyžadováno	str ID spuštění spuštění kanálu.
_service_endpoint	str Koncový bod, ke kterému se chcete připojit. Default value: None
experiment Vyžadováno	Experiment Objekt experimentu přidružený ke spuštění kanálu.
run_id Vyžadováno	str ID spuštění spuštění kanálu.
_service_endpoint Vyžadováno	str Koncový bod, ke kterému se chcete připojit.

Poznámky

Objekt PipelineRun se vrátí při odeslání objektu Pipeline submitprostřednictvím . Experimentmetoda metody . Další informace o tom, jak vytvořit a odeslat kanál, najdete tady: https://aka.ms/pl-first-pipeline.

Spuštění kanálu je také možné vytvořit instanci s spuštěním Experiment , na které bylo odesláno, a ID spuštění kanálu následujícím způsobem:


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

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

Při práci s PipelineRun použijte:

wait_for_completion monitorování stavu spuštění a volitelně streamování protokolů spuštění.
get_status a načte stav spuštění.
cancel a zrušíte probíhající spuštění kanálu.
get_steps a zobrazí se seznam vygenerovaných spuštění kroků. Spuštění kanálu vygeneruje StepRun pro každý krok v kanálu .

Metody

cancel	Zrušte probíhající spuštění.
child_run	Vytvořte podřízené spuštění pro spuštění kanálu. Tato metoda není implementována pro PipelineRun.
complete	Označte spuštění kanálu jako dokončené. Tato metoda není implementována pro PipelineRun. Tato metoda není podporována pro kanály; Stav dokončení nebo selhání spravuje back-end Azure ML.
fail	Označte spuštění kanálu jako neúspěšné. Tato metoda není implementována pro PipelineRun. Tato metoda není podporována pro kanály; Stav dokončení nebo selhání spravuje back-end Azure ML.
find_step_run	Vyhledejte krok spuštěný v kanálu podle názvu.
get	Načtení spuštění kanálu na základě ID spuštění
get_graph	Získejte graf spuštění kanálu.
get_pipeline_output	Získejte PortDataReference pro daný výstup kanálu.
get_pipeline_runs	Načtěte spuštění kanálu vygenerovaná z publikovaného kanálu.
get_status	Načtěte nejnovější stav spuštění kanálu ze služby. Mezi běžné vrácené hodnoty patří "Spuštěno", "Dokončeno" a "Selhání".
get_steps	Získejte spuštění kroků pro všechny kroky kanálu, které byly dokončeny nebo začaly běžet.
get_tags	Získejte sadu značek pro spuštění.
publish_pipeline	Publikujte kanál a zpřístupněte ho pro opětovné spuštění. Koncový bod kanálu můžete získat z objektu PublishedPipeline vráceného touto funkcí. Pomocí koncového bodu kanálu můžete kanál vyvolat z externích aplikací pomocí volání REST. Informace o ověřování při volání koncových bodů REST najdete v tématu https://aka.ms/pl-restep-auth. Původní kanál přidružený ke spuštění kanálu se používá jako základ pro publikovaný kanál.
save	Uložte YAML kanálu do souboru.
wait_for_completion	Počkejte na dokončení tohoto spuštění kanálu. Vrátí stav po čekání.

cancel

Zrušte probíhající spuštění.

cancel()

child_run

Vytvořte podřízené spuštění pro spuštění kanálu. Tato metoda není implementována pro PipelineRun.

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

Parametry

Name	Description
name	str Nepovinný název podřízeného souboru. Default value: None
run_id	str Volitelné ID spuštění pro podřízenou položku, jinak použije výchozí. Default value: None
outputs	str Volitelné výstupy adresáře, který se má sledovat pro podřízenou složku. Default value: None

Návraty

Typ	Description
Run	Podřízené spuštění.

Výjimky

Typ	Description
NotImplementedError

complete

Označte spuštění kanálu jako dokončené. Tato metoda není implementována pro PipelineRun.

Tato metoda není podporována pro kanály; Stav dokončení nebo selhání spravuje back-end Azure ML.

complete()

Výjimky

Typ	Description
NotImplementedError

fail

Označte spuštění kanálu jako neúspěšné. Tato metoda není implementována pro PipelineRun.

Tato metoda není podporována pro kanály; Stav dokončení nebo selhání spravuje back-end Azure ML.

fail()

Výjimky

Typ	Description
NotImplementedError

find_step_run

Vyhledejte krok spuštěný v kanálu podle názvu.

find_step_run(name)

Parametry

Name	Description
name Vyžadováno	str Název kroku, který chcete najít.

Návraty

Typ	Description
list	StepRun Seznam objektů se zadaným názvem

get

Načtení spuštění kanálu na základě ID spuštění

static get(workspace, run_id, _service_endpoint=None)

Parametry

Name	Description
workspace Vyžadováno	Workspace Pracovní prostor přidružený k kanálu.
run_id Vyžadováno	str ID spuštění kanálu.
_service_endpoint	str Koncový bod, ke kterému se chcete připojit. Default value: None

Návraty

Typ	Description
PipelineRun	Objekt PipelineRun

get_graph

Získejte graf spuštění kanálu.

get_graph()

Návraty

Typ	Description
Graph	Graf.

get_pipeline_output

Získejte PortDataReference pro daný výstup kanálu.

get_pipeline_output(pipeline_output_name)

Parametry

Name	Description
pipeline_output_name Vyžadováno	str Název výstupu kanálu, který chcete získat.

Návraty

Typ	Description
PortDataReference	PortDataReference představující výstupní data kanálu.

get_pipeline_runs

Načtěte spuštění kanálu vygenerovaná z publikovaného kanálu.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parametry

Name	Description
workspace Vyžadováno	Workspace Pracovní prostor přidružený k kanálu.
pipeline_id Vyžadováno	str ID publikovaného kanálu.
_service_endpoint	str Koncový bod, ke kterému se chcete připojit. Default value: None

Návraty

Typ	Description
list	Seznam PipelineRun objektů.

get_status

Načtěte nejnovější stav spuštění kanálu ze služby.

Mezi běžné vrácené hodnoty patří "Spuštěno", "Dokončeno" a "Selhání".

get_status()

Návraty

Typ	Description
str	Nejnovější stav jako řetězec.

Poznámky

NotStarted – jedná se o dočasný stav objektů spuštění na straně klienta před odesláním do cloudu.
Spuštěno – úloha se začala spouštět v cílovém výpočetním objektu.
Selhání – Spuštění se nezdařilo. Vlastnost Error při spuštění obvykle obsahuje podrobnosti o důvodech.
Dokončeno – spuštění bylo úspěšně dokončeno.
Zrušeno – po žádosti o zrušení se teď spuštění úspěšně zrušilo.


   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

Získejte spuštění kroků pro všechny kroky kanálu, které byly dokončeny nebo začaly běžet.

get_steps()

Návraty

Typ	Description
list	Seznam StepRun objektů.

get_tags

Získejte sadu značek pro spuštění.

get_tags()

Návraty

Typ	Description
dict	Slovník značek pro spuštění.

publish_pipeline

Publikujte kanál a zpřístupněte ho pro opětovné spuštění.

Koncový bod kanálu můžete získat z objektu PublishedPipeline vráceného touto funkcí. Pomocí koncového bodu kanálu můžete kanál vyvolat z externích aplikací pomocí volání REST. Informace o ověřování při volání koncových bodů REST najdete v tématu https://aka.ms/pl-restep-auth.

Původní kanál přidružený ke spuštění kanálu se používá jako základ pro publikovaný kanál.

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

Parametry

Name	Description
name Vyžadováno	str Název publikovaného kanálu.
description Vyžadováno	str Popis publikovaného kanálu.
version Vyžadováno	str Verze publikovaného kanálu.
continue_on_step_failure	bool Jestli chcete pokračovat v provádění dalších kroků v části PipelineRun v případě selhání kroku. Výchozí hodnota je Nepravda. Default value: None
kwargs Vyžadováno	dict Argumenty vlastních klíčových slov vyhrazené pro budoucí vývoj

Návraty

Typ	Description
PublishedPipeline	Vytvořil se publikovaný kanál.

save

Uložte YAML kanálu do souboru.

save(path=None)

Parametry

Name	Description
path	str Cesta k uložení YAML do. Pokud je cesta adresář, uloží se soubor YAML kanálu na path<>/pipeline.yml. Pokud cesta není žádná, použije se aktuální adresář. Default value: None

Návraty

Typ	Description
None

wait_for_completion

Počkejte na dokončení tohoto spuštění kanálu.

Vrátí stav po čekání.

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

Parametry

Name	Description
show_output	bool Určuje, jestli se má zobrazit stav spuštění kanálu na sys.stdout. Default value: True
timeout_seconds	int Počet sekund čekání před vypršením časového limitu. Default value: 9223372036854775807
raise_on_error	bool Určuje, jestli se má vyvolat chyba, když je spuštění ve stavu selhání. Default value: True

Návraty

Typ	Description
str	Konečný stav.

Sdílet prostřednictvím

PipelineRun Třída

Konstruktor

Parametry

Poznámky

Metody

cancel

child_run

Parametry

Návraty

Výjimky

complete

Výjimky

fail

Výjimky

find_step_run

Parametry

Návraty

get

Parametry

Návraty

get_graph

Návraty

get_pipeline_output

Parametry

Návraty

get_pipeline_runs

Parametry

Návraty

get_status

Návraty

Poznámky

get_steps

Návraty

get_tags

Návraty

publish_pipeline

Parametry

Návraty

save

Parametry

Návraty

wait_for_completion

Parametry

Návraty

Váš názor

Další materiály