PipelineRun Osztály

Egy futtatási elemet Pipelinejelöl.

Ez az osztály a folyamatfuttatás elküldése után kezelhető, ellenőrizheti az állapotot és lekérheti a futtatási adatokat. A használatával get_steps lekérheti a StepRun folyamatfuttatás által létrehozott objektumokat. Más felhasználási módok közé tartozik a Graph folyamatfuttatáshoz társított objektum lekérése, a folyamatfuttatás állapotának lekérése és a futtatás befejezésére való várakozás.

Folyamatfuttatás inicializálása.

Öröklődés
PipelineRun

Konstruktor

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

Paraméterek

experiment
Experiment
Kötelező

A folyamatfuttatáshoz társított kísérletobjektum.

run_id
str
Kötelező

A folyamatfuttatás futtatási azonosítója.

_service_endpoint
str
alapértelmezett érték: None

A végpont, amelyhez csatlakozni szeretne.

experiment
Experiment
Kötelező

A folyamatfuttatáshoz társított kísérletobjektum.

run_id
str
Kötelező

A folyamatfuttatás futtatási azonosítója.

_service_endpoint
str
Kötelező

A végpont, amelyhez csatlakozni szeretne.

Megjegyzések

Egy PipelineRun objektumot ad vissza a függvény, amikor a () segítségével küldi el az submitobjektumotPipeline. metódusa Experiment. A folyamat létrehozásával és elküldésével kapcsolatos további információkért lásd: https://aka.ms/pl-first-pipeline.

A PipelineRun példányosítható a futtatás elküldésekor Experiment és a PipelineRun azonosítójával is az alábbiak szerint:


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

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

A PipelineRun használata esetén használja a következőt:

  • wait_for_completion a futtatási állapot monitorozásához és opcionálisan a futtatási naplók streameléséhez.

  • get_status a futtatási állapot lekéréséhez.

  • cancel folyamatban lévő PipelineRun megszakításához.

  • get_steps a létrehozott Lépésfuttatások listázásához. A PipelineRun a folyamat minden lépéséhez létrehoz egy-egy StepRun elemet.

Metódusok

cancel

A folyamatban lévő futtatás megszakítása.

child_run

Hozzon létre egy gyermekfuttatást a folyamatfuttatáshoz. Ez a metódus nincs implementálva a PipelineRun esetében.

complete

A folyamatfuttatás megjelölése befejezettként. Ez a metódus nincs implementálva a PipelineRun esetében.

Ez a módszer nem támogatott folyamatok esetében; A befejezési/sikertelen állapotot az Azure ML háttérrendszere kezeli.

fail

Jelölje meg a folyamatfuttatást sikertelenként. Ez a metódus nincs implementálva a PipelineRun esetében.

Ez a módszer nem támogatott folyamatok esetében; A befejezési/sikertelen állapotot az Azure ML háttérrendszere kezeli.

find_step_run

Keresse meg a lépésfuttatást a folyamatban név szerint.

get

Folyamatfuttatás lekérése futtatási azonosító alapján.

get_graph

A folyamatfuttatás gráfjának lekérése.

get_pipeline_output

Kérje le az adott folyamatkimenet PortDataReference értékét.

get_pipeline_runs

Kérje le a közzétett folyamatból létrehozott folyamatfuttatásokat.

get_status

Kérje le a folyamatfuttatás legújabb állapotát a szolgáltatásból.

A visszaadott gyakori értékek közé tartozik a "Futtatás", a "Kész" és a "Sikertelen".

get_steps

A lépésfuttatások lekérése az összes befejezett vagy megkezdett folyamatlépéshez.

get_tags

Kérje le a futtatáshoz tartozó címkék készletét.

publish_pipeline

Hozzon létre egy folyamatot, és tegye elérhetővé újrafuttatásra.

A folyamatvégpontot a függvény által visszaadott PublishedPipeline objektumból szerezheti be. A folyamatvégponttal REST-hívásokkal meghívhatja a folyamatot külső alkalmazásokból. A REST-végpontok hívása során történő hitelesítésről további információt a következő témakörben talál https://aka.ms/pl-restep-auth: .

A rendszer a folyamatfuttatáshoz társított eredeti folyamatot használja a közzétett folyamat alapjául.

save

Mentse a folyamat YAML-ét egy fájlba.

wait_for_completion

Várja meg a folyamatfuttatás befejezését.

A várakozás utáni állapotot adja vissza.

cancel

A folyamatban lévő futtatás megszakítása.

cancel()

child_run

Hozzon létre egy gyermekfuttatást a folyamatfuttatáshoz. Ez a metódus nincs implementálva a PipelineRun esetében.

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

Paraméterek

name
str
alapértelmezett érték: None

A gyermek nem kötelező neve.

run_id
str
alapértelmezett érték: None

A gyermek opcionális futtatási azonosítója, máskülönben az alapértelmezettet használja.

outputs
str
alapértelmezett érték: None

Nem kötelező kimenetek könyvtára a gyermek nyomon követéséhez.

Válaszok

A gyermek fut.

Visszatérési típus

Run

Kivételek

complete

A folyamatfuttatás megjelölése befejezettként. Ez a metódus nincs implementálva a PipelineRun esetében.

Ez a módszer nem támogatott folyamatok esetében; A befejezési/sikertelen állapotot az Azure ML háttérrendszere kezeli.

complete()

Kivételek

fail

Jelölje meg a folyamatfuttatást sikertelenként. Ez a metódus nincs implementálva a PipelineRun esetében.

Ez a módszer nem támogatott folyamatok esetében; A befejezési/sikertelen állapotot az Azure ML háttérrendszere kezeli.

fail()

Kivételek

find_step_run

Keresse meg a lépésfuttatást a folyamatban név szerint.

find_step_run(name)

Paraméterek

name
str
Kötelező

A keresendő lépés neve.

Válaszok

A StepRun megadott nevű objektumok listája.

Visszatérési típus

get

Folyamatfuttatás lekérése futtatási azonosító alapján.

static get(workspace, run_id, _service_endpoint=None)

Paraméterek

workspace
Workspace
Kötelező

A folyamathoz társított munkaterület.

run_id
str
Kötelező

A folyamatfuttatás azonosítója.

_service_endpoint
str
alapértelmezett érték: None

A végpont, amelyhez csatlakozni szeretne.

Válaszok

Az PipelineRun objektum.

Visszatérési típus

get_graph

A folyamatfuttatás gráfjának lekérése.

get_graph()

Válaszok

A gráf.

Visszatérési típus

get_pipeline_output

Kérje le az adott folyamatkimenet PortDataReference értékét.

get_pipeline_output(pipeline_output_name)

Paraméterek

pipeline_output_name
str
Kötelező

A lekérendő folyamatkimenet neve.

Válaszok

A folyamat kimeneti adatait képviselő PortDataReference.

Visszatérési típus

get_pipeline_runs

Kérje le a közzétett folyamatból létrehozott folyamatfuttatásokat.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Paraméterek

workspace
Workspace
Kötelező

A folyamathoz társított munkaterület.

pipeline_id
str
Kötelező

A közzétett folyamat azonosítója.

_service_endpoint
str
alapértelmezett érték: None

A végpont, amelyhez csatlakozni szeretne.

Válaszok

Objektumok listája PipelineRun .

Visszatérési típus

get_status

Kérje le a folyamatfuttatás legújabb állapotát a szolgáltatásból.

A visszaadott gyakori értékek közé tartozik a "Futtatás", a "Kész" és a "Sikertelen".

get_status()

Válaszok

A legújabb állapot sztringként.

Visszatérési típus

str

Megjegyzések

  • NotStarted – Ez egy ideiglenes állapotú ügyféloldali Futtatási objektumok a felhőbeküldés előtt

  • Futtatás – A feladat a számítási célban kezdett futni.

  • Sikertelen – A futtatás sikertelen volt. Általában a Futtatás hiba tulajdonsága adja meg a részleteket, hogy miért.

  • Kész – A futtatás sikeresen befejeződött.

  • Megszakítva – A lemondási kérést követően a futtatás sikeresen megszakadt.


   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

A lépésfuttatások lekérése az összes befejezett vagy megkezdett folyamatlépéshez.

get_steps()

Válaszok

Objektumok listája StepRun .

Visszatérési típus

get_tags

Kérje le a futtatáshoz tartozó címkék készletét.

get_tags()

Válaszok

A futtatás címkéinek szótára.

Visszatérési típus

publish_pipeline

Hozzon létre egy folyamatot, és tegye elérhetővé újrafuttatásra.

A folyamatvégpontot a függvény által visszaadott PublishedPipeline objektumból szerezheti be. A folyamatvégponttal REST-hívásokkal meghívhatja a folyamatot külső alkalmazásokból. A REST-végpontok hívása során történő hitelesítésről további információt a következő témakörben talál https://aka.ms/pl-restep-auth: .

A rendszer a folyamatfuttatáshoz társított eredeti folyamatot használja a közzétett folyamat alapjául.

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

Paraméterek

name
str
Kötelező

A közzétett folyamat neve.

description
str
Kötelező

A közzétett folyamat leírása.

version
str
Kötelező

A közzétett folyamat verziója.

continue_on_step_failure
bool
alapértelmezett érték: None

Ha egy lépés meghiúsul, folytassa-e a folyamatfuttatás egyéb lépéseinek végrehajtását. Az alapértelmezett érték Hamis.

kwargs
dict
Kötelező

Egyéni kulcsszóargumentumok, jövőbeli fejlesztéshez fenntartva

Válaszok

Közzétett folyamat létrehozása.

Visszatérési típus

save

Mentse a folyamat YAML-ét egy fájlba.

save(path=None)

Paraméterek

path
str
alapértelmezett érték: None

A YAML mentési útvonala. Ha az elérési út egy könyvtár, a folyamat YAML-fájlja a path>/pipeline.yml fájlba <lesz mentve. Ha az elérési út nincs, a rendszer az aktuális könyvtárat használja.

Visszatérési típus

wait_for_completion

Várja meg a folyamatfuttatás befejezését.

A várakozás utáni állapotot adja vissza.

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

Paraméterek

show_output
bool
alapértelmezett érték: True

Azt jelzi, hogy meg szeretné-e jeleníteni a folyamatfuttatás állapotát a sys.stdout webhelyen.

timeout_seconds
int
alapértelmezett érték: 9223372036854775807

Az időtúllépés előtt várakozó másodpercek száma.

raise_on_error
bool
alapértelmezett érték: True

Azt jelzi, hogy hibát kell-e okozni, ha a futtatás sikertelen állapotban van.

Válaszok

A végső állapot.

Visszatérési típus

str