PublishedPipeline Osztály

  • Referencia

Egy olyan folyamatot jelöl, amelyet az azt felépített Python-kód nélkül kell elküldeni.

Emellett a PublishedPipeline használatával újraküldheti a Pipeline különböző PipelineParameter értékeket és bemeneteket tartalmazó fájlokat.

A PublishedPipeline inicializálása.

:p aram végpont A folyamat futtatásának elküldéséhez szükséges REST-végpont URL-címe. :type endpoint: str :p aram total_run_steps: A folyamat lépéseinek száma :type total_run_steps: int :p aram workspace: A közzétett folyamat munkaterülete. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: További lépések végrehajtása a PipelineRunban

ha egy lépés meghiúsul, az alapértelmezett érték hamis.

Öröklődés
azureml.core._portal.HasPipelinePortal
PublishedPipeline

Konstruktor

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

Paraméterek

name
str
Kötelező

A közzétett folyamat neve.

graph_id
str
Kötelező

A közzétett folyamat gráfjának azonosítója.

description
str
Kötelező

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

version
str
Kötelező

A közzétett folyamat verziója.

published_pipeline_id
str
Kötelező

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

status
str
Kötelező

A közzétett folyamat állapota ('Aktív' vagy 'Letiltva').

endpoint
str
Kötelező

A folyamat futtatásának elküldéséhez használt REST-végpont URL-címe.

total_run_steps
int
Kötelező

A folyamat lépéseinek száma.

workspace
Workspace
Kötelező

A közzétett folyamat munkaterülete.

continue_on_step_failure
bool
Kötelező

Azt határozza meg, hogy folytatja-e a folyamatfuttatás más lépéseinek végrehajtását, ha egy lépés meghiúsul. Az alapértelmezett érték hamis.

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Kötelező

A közzétett folyamatszolgáltató.

kwargs
dict
Kötelező

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

name
str
Kötelező

A közzétett folyamat neve.

graph_id
str
Kötelező

A közzétett folyamat gráfjának azonosítója.

description
str
Kötelező

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

version
str
Kötelező

A közzétett folyamat verziója.

published_pipeline_id
str
Kötelező

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

status
str
Kötelező

A közzétett folyamat állapota ('Aktív' vagy 'Letiltva').

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Kötelező

A közzétett folyamatszolgáltató.

kwargs
dict
Kötelező

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

Megjegyzések

A PublishedPipeline egy vagy egy PipelinePipelineRunfájlból hozható létre.

Egy folyamatból való közzétételre példa a következő:


   from azureml.pipeline.core import Pipeline

   pipeline = Pipeline(workspace=ws, steps=steps)
   published_pipeline = pipeline.publish(name="My_New_Pipeline",
                                         description="My New Pipeline Description",
                                         version="1.0",
                                         continue_on_step_failure=True)

PipelineRun-ból való közzétételhez használja a következőt:


   from azureml.pipeline.core import PipelineRun

   pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
   published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
                                                      description="My New Pipeline Description",
                                                      version="1.0",
                                                      continue_on_step_failure=True)

Megjegyzés: a continue_on_step_failure paraméter azt határozza meg, hogy a folyamat lépéseinek végrehajtása folytatódik-e, ha egy lépés meghiúsul. Az alapértelmezett érték Hamis, ami azt jelenti, hogy ha egy lépés meghiúsul, a folyamat végrehajtása leáll, megszakítva a futó lépéseket.

Küldjön be egy PublishedPipeline-t a használatával submit. A küldés meghívásakor létrejön egy PipelineRun , amely objektumokat hoz létre StepRun a munkafolyamat minden lépéséhez.

A PublishedPipeline elküldésére a következő példa látható:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

A PublishedPipeline elküldésekor számos választható beállítás adható meg. Ezek a következők:

  • continue_on_step_failure: Ha egy lépés meghiúsul, a Folyamatfuttatás más lépéseinek végrehajtása nem kötelező. Csak azok a lépések fognak folytatódni, amelyek nem függnek a sikertelen lépés kimenetétől. Ha meg van adva, ez a paraméterbeállítás felülbírálja a Folyamat beállítását.

  • pipeline_parameters: A folyamatok végrehajtásának paraméterei, a(z) {name: value} szótára. További részletekért lásd PipelineParameter .

  • parent_run_id: Megadhat egy futtatási azonosítót a folyamatfuttatás szülőfuttatásának beállításához, amely a RunHistoryban is megjelenik. A szülőfuttatásnak ugyanahhoz a kísérlethez kell tartoznia, mint az elküldött folyamatnak.

A PublishedPipeline-t az alábbi beállításokkal küldheti el:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline,
                                    continue_on_step_failure=True,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>")

Minden közzétett folyamat rendelkezik REST-végpontokkal. A folyamatvégponttal elindíthatja a folyamat futtatását külső rendszerekből, például nem Python-ügyfelekbő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 végpont használata lehetővé teszi például a "felügyelt ismételhetőséget" kötegelt pontozási és újratanítási forgatókönyvekben. További információ: https://aka.ms/pl-first-pipeline.

Metódusok

disable

Állítsa a közzétett folyamatot "Letiltva" értékre, és nem futtatható.
enable

Állítsa a közzétett folyamatot "Aktív" értékre, és futtassa.
get

A közzétett folyamat lekérése.
get_all

Az aktuális munkaterület összes közzétett folyamatának lekérése.

ELAVULT: Ez a metódus elavult a PublishedPipeline list metódus javára.
get_graph

A PublishedPipeline grafikonjának lekérése.
get_step_names

A lépések nevének listájának lekérése a PublishedPipeline-ban.
list

Az aktuális munkaterület összes közzétett folyamatának lekérése.
save

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

Jelenleg csak a ModuleSteps-ekből álló folyamatok támogatottak a YAML-exportáláshoz.
submit

Küldje el a közzétett folyamatot. Ez egyenértékű a használatával submit.

A beküldött PipelineRunértéket adja vissza. Ezzel az objektummal figyelheti és tekintheti meg a futtatás részleteit.

disable

Állítsa a közzétett folyamatot "Letiltva" értékre, és nem futtatható.

disable()

enable

Állítsa a közzétett folyamatot "Aktív" értékre, és futtassa.

enable()

get

A közzétett folyamat lekérése.

static get(workspace, id, _workflow_provider=None, _service_endpoint=None)

Paraméterek

workspace
Workspace
Kötelező

A munkaterület, amelyben a közzétett folyamat létre lett hozva.

id
str
Kötelező

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

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
alapértelmezett érték: None

A munkafolyamat-szolgáltató.

_service_endpoint
str
alapértelmezett érték: None

A szolgáltatásvégpont.

Válaszok

Egy PublishedPipeline objektum.

Visszatérési típus

PublishedPipeline

get_all

Az aktuális munkaterület összes közzétett folyamatának lekérése.

ELAVULT: Ez a metódus elavult a PublishedPipeline list metódus javára.

static get_all(workspace, active_only=True, _service_endpoint=None)

Paraméterek

workspace
Workspace
Kötelező

A munkaterület, amelyen a közzétett folyamat létre lett hozva.

active_only
bool
alapértelmezett érték: True

Azt határozza meg, hogy csak a jelenleg aktív közzétett folyamatokat adja-e vissza.

_service_endpoint
str
alapértelmezett érték: None

A szolgáltatásvégpont.

Válaszok

A PublishedPipeline objektumok listája.

Visszatérési típus

list[PublishedPipeline]

get_graph

A PublishedPipeline grafikonjának lekérése.

get_graph(_workflow_provider=None)

Paraméterek

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
alapértelmezett érték: None

A munkafolyamat-szolgáltató.

Válaszok

A gráf.

Visszatérési típus

Graph

get_step_names

A lépések nevének listájának lekérése a PublishedPipeline-ban.

get_step_names(_workflow_provider=None)

Paraméterek

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
alapértelmezett érték: None

A munkafolyamat-szolgáltató.

Válaszok

A Lépések neveinek listája a PublishedPipeline-ban.

Visszatérési típus

List[str]

list

Az aktuális munkaterület összes közzétett folyamatának lekérése.

static list(workspace, active_only=True, _service_endpoint=None)

Paraméterek

workspace
Workspace
Kötelező

A munkaterület, amelyben a közzétett folyamat létre lett hozva.

active_only
bool
alapértelmezett érték: True

Azt határozza meg, hogy csak a jelenleg aktív közzétett folyamatokat adja-e vissza.

_service_endpoint
str
alapértelmezett érték: None

A szolgáltatásvégpont.

Válaszok

A PublishedPipeline objektumok listája.

Visszatérési típus

list[PublishedPipeline]

save

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

Jelenleg csak a ModuleSteps-ekből álló folyamatok támogatottak a YAML-exportáláshoz.

save(path=None, _workflow_provider=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_name.yml fájlba lesz mentve. Ha az elérési út Nincs, a rendszer az aktuális könyvtárat használja.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
alapértelmezett érték: None

A munkafolyamat-szolgáltató.

Visszatérési típus

None

submit

Küldje el a közzétett folyamatot. Ez egyenértékű a használatával submit.

A beküldött PipelineRunértéket adja vissza. Ezzel az objektummal figyelheti és tekintheti meg a futtatás részleteit.

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

Paraméterek

workspace
Workspace
Kötelező

A közzétett folyamat elküldéséhez a munkaterület.

experiment_name
str
Kötelező

Annak a kísérletnek a neve, amelyet be szeretne küldeni.

pipeline_parameters
dict
alapértelmezett érték: None

Paraméterek szótára új értékek hozzárendeléséhez {param name, param value}. További részletekért lásd PipelineParameter : .

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
alapértelmezett érték: None

A munkafolyamat-szolgáltató.

_service_endpoint
str
alapértelmezett érték: None

A szolgáltatásvégpont.

parent_run_id
str
alapértelmezett érték: None

A folyamatfuttatás szülőfuttatásához megadható nem kötelező futtatási azonosító, amely a RunHistoryban is megjelenik. A szülőfuttatásnak ugyanahhoz a kísérlethez kell tartoznia, amelyhez a folyamat be van küldve.

continue_on_step_failure
bool
alapértelmezett érték: None

Nem kötelező, hogy egy lépés meghiúsulása esetén a Folyamatfuttatásban folytassa-e a többi lépés végrehajtását. Ha meg van adva, felülbírálja a beállítást a folyamaton.

Válaszok

Az elküldött folyamat fut.

Visszatérési típus

PipelineRun

Attribútumok

continue_on_step_failure

A beállítás értékének lekérése continue_on_step_failure .

Válaszok

A beállítás értéke continue_on_step_failure .

Visszatérési típus

bool

description

A közzétett folyamat leírásának lekérése.

Válaszok

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

Visszatérési típus

str

endpoint

Kérje le a REST-végpont URL-címét egy közzétett folyamat futtatásához.

Válaszok

A közzétett folyamat futtatásához használt REST-végpont URL-címe.

Visszatérési típus

str

graph_id

Kérje le a közzétett folyamat gráfjának azonosítóját.

Válaszok

A gráf azonosítója.

Visszatérési típus

str

id

Kérje le a közzétett folyamat azonosítóját.

Válaszok

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

Visszatérési típus

str

name

Kérje le a közzétett folyamat nevét.

Válaszok

A közzétett folyamat neve.

Visszatérési típus

str

status

Kérje le a közzétett folyamat állapotát.

Válaszok

A közzétett folyamat állapota.

Visszatérési típus

str

total_run_steps

A folyamat lépéseinek számának lekérése.

Válaszok

A folyamat lépéseinek száma.

Visszatérési típus

int

version

A közzétett folyamat verziójának lekérése.

Válaszok

A közzétett folyamat verziója.

Visszatérési típus

str