PipelineRun Třída

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

experiment

Experiment

Vyžadováno

Objekt experimentu přidružený ke spuštění kanálu.

run_id

str

Vyžadováno

ID spuštění kanálu.

_service_endpoint

str

výchozí hodnota: None

Koncový bod, ke kterému se chcete připojit.

experiment

Experiment

Vyžadováno

Objekt experimentu přidružený ke spuštění kanálu.

run_id

str

Vyžadováno

ID spuštění kanálu.

_service_endpoint

str

Vyžadováno

Koncový bod, ke kterému se chcete připojit.

Poznámky

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

Instanci spuštění kanálu je také možné vytvořit s Experiment použitím spuštění odeslaného do 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 se spuštěním kanálu použijte:

• wait_for_completion monitorujte stav spuštění a volitelně streamujte protokoly spuštění.

• get_status a načte stav spuštění.

• cancel pro zrušení probíhajícího 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í implementovaná pro PipelineRun.
complete	Označte spuštění kanálu jako dokončené. Tato metoda není implementovaná 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í implementovaná 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čte 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 ze služby nejnovější stav spuštění kanálu. Mezi běžné vrácené hodnoty patří Running (Spuštěno), Finished (Dokončeno) a Failed (Selhání).
get_steps	Získejte spuštění kroků pro všechny dokončené nebo spuštěné kroky kanálu.
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žije 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í implementovaná pro PipelineRun.

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

Parametry

name

str

výchozí hodnota: None

Volitelný název pro dítě.

run_id

str

výchozí hodnota: None

Volitelné ID spuštění pro podřízenou položku, jinak se použije výchozí hodnota.

outputs

str

výchozí hodnota: None

Volitelný výstupní adresář, který se má sledovat pro podřízenou složku.

Návraty

Podřízené spuštění.

Návratový typ

Run

Výjimky

NotImplementedError

complete

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

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

complete()

Výjimky

NotImplementedError

fail

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

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

fail()

Výjimky

NotImplementedError

find_step_run

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

find_step_run(name)

Parametry

name

str

Vyžadováno

Název kroku, který chcete najít.

Návraty

StepRun Seznam objektů se zadaným názvem

Návratový typ

list

get

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

static get(workspace, run_id, _service_endpoint=None)

Parametry

workspace

Workspace

Vyžadováno

Pracovní prostor přidružený ke kanálu.

run_id

str

Vyžadováno

ID spuštění kanálu.

_service_endpoint

str

výchozí hodnota: None

Koncový bod, ke kterému se chcete připojit.

Návraty

Objekt PipelineRun

Návratový typ

PipelineRun

get_graph

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

get_graph()

Návraty

Graf

Návratový typ

Graph

get_pipeline_output

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

get_pipeline_output(pipeline_output_name)

Parametry

pipeline_output_name

str

Vyžadováno

Název výstupu kanálu, který chcete získat.

Návraty

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

Návratový typ

PortDataReference

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

workspace

Workspace

Vyžadováno

Pracovní prostor přidružený ke kanálu.

pipeline_id

str

Vyžadováno

ID publikovaného kanálu.

_service_endpoint

str

výchozí hodnota: None

Koncový bod, ke kterému se chcete připojit.

Návraty

Seznam PipelineRun objektů.

Návratový typ

list

get_status

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

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

get_status()

Návraty

Nejnovější stav jako řetězec.

Návratový typ

str

Poznámky

• NotStarted – jedná se o dočasný stav objektů spuštění na straně klienta, které jsou v 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.

• Neúspěšné – spuštění se nezdařilo. Vlastnost Error při spuštění obvykle obsahuje podrobné informace o tom, proč tomu tak je.

• 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 dokončené nebo spuštěné kroky kanálu.

get_steps()

Návraty

Seznam StepRun objektů.

Návratový typ

list

get_tags

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

get_tags()

Návraty

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

Návratový typ

dict

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žije jako základ pro publikovaný kanál.

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

Parametry

name

str

Vyžadováno

Název publikovaného kanálu.

description

str

Vyžadováno

Popis publikovaného kanálu.

version

str

Vyžadováno

Verze publikovaného kanálu.

continue_on_step_failure

bool

výchozí hodnota: None

Jestli chcete pokračovat v provádění dalších kroků v části PipelineSpustit, pokud se některý krok nezdaří. Výchozí hodnota je Nepravda.

kwargs

dict

Vyžadováno

Argumenty vlastních klíčových slov vyhrazené pro budoucí vývoj

Návraty

Vytvořil se publikovaný kanál.

Návratový typ

PublishedPipeline

save

Uložte yaml kanálu do souboru.

save(path=None)

Parametry

path

str

výchozí hodnota: None

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

Návratový typ

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

show_output

bool

výchozí hodnota: True

Určuje, jestli se má zobrazit stav spuštění kanálu v sys.stdout.

timeout_seconds

int

výchozí hodnota: 9223372036854775807

Počet sekund čekání před vypršením časového limitu.

raise_on_error

bool

výchozí hodnota: True

Určuje, jestli se má vyvolat chyba, když je spuštění ve stavu selhání.

Návraty

Konečný stav.

Návratový typ

str