PipelineEndpoint Třída

Reference

Pipeline Představuje pracovní postup, který lze aktivovat z jedinečné adresy URL koncového bodu.

PipelineEndpoints se dají použít k vytváření nových verzí objektů se PublishedPipeline zachováním stejného koncového bodu. Koncové body kanálu mají jedinečný název v rámci pracovního prostoru.

Pomocí atributu koncového bodu objektu PipelineEndpoint můžete aktivovat nová spuštění kanálu 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.

Další informace o vytváření a spouštění kanálů strojového učení najdete v tématu https://aka.ms/pl-first-pipeline.

Inicializujte PipelineEndpoint.

Dědičnost: builtins.object

PipelineEndpoint

Konstruktor

PipelineEndpoint(workspace, id, name, description, status, default_version, endpoint, pipeline_version_list, _pipeline_endpoint_provider=None, _published_pipeline_provider=None, _swaggerurl=None)

Parametry

Name	Description
workspace Vyžadováno	Workspace Pracovní prostor, ve který je definovaný parametr PipelineEndpoint.
id Vyžadováno	str ID koncového bodu kanálu.
name Vyžadováno	str Název koncového bodu kanálu.
description Vyžadováno	str Popis koncového bodu kanálu.
status Vyžadováno	str Nový stav parametru PipelineEndpoint: "Aktivní" nebo "Zakázáno".
default_version Vyžadováno	str Výchozí verze kanálu v pipelineEndpoint, automatické přírůstky, začíná na "0".
endpoint Vyžadováno	str Adresa URL koncového bodu REST pro pipelineEndpoint, kterou lze použít k odesílání spuštění kanálu.
pipeline_version_list Vyžadováno	list Seznam PipelineIdVersion objektů.
_pipeline_endpoint_provider Vyžadováno	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Zprostředkovatel PipelineEndpoint.
_pipeline_endpoint_provider Vyžadováno	Zprostředkovatel PublishedPipeline.
workspace Vyžadováno	Workspace Objekt pracovního prostoru, do který bude tento PipelineEndpoint patřit.
id Vyžadováno	str ID koncového bodu kanálu.
name Vyžadováno	str Název koncového bodu kanálu.
description Vyžadováno	str Popis koncového bodu kanálu.
status Vyžadováno	str Nový stav parametru PipelineEndpoint: "Aktivní" nebo "Zakázáno".
default_version Vyžadováno	str Výchozí verze kanálu v pipelineEndpoint, automatické přírůstky, začíná na "0".
endpoint Vyžadováno	str Adresa URL koncového bodu REST pro PipelineEndpoint k odeslání spuštění kanálu
pipeline_version_list Vyžadováno	list Seznam PipelineIdVersion
_pipeline_endpoint_provider Vyžadováno	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Zprostředkovatel PipelineEndpoint.
_pipeline_endpoint_provider Vyžadováno	Zprostředkovatel PublishedPipeline.
swaggerendpoint Vyžadováno	Adresa URL koncového bodu REST Swaggeru pro PipelineEndpoint k odeslání spuštění kanálu

Poznámky

Koncový bod kanálu lze vytvořit buď z objektu PublishedPipeline, Pipeline nebo .

Příklad publikování z kanálu nebo Publikovanéhopipeline je následující:


   from azureml.pipeline.core import PipelineEndpoint

   # The pipeline argument can be either a Pipeline or a PublishedPipeline
   pipeline_endpoint = PipelineEndpoint.publish(workspace=ws,
                                                name="PipelineEndpointName",
                                                pipeline=pipeline,
                                                description="New Pipeline Endpoint")

Odešlete koncový bod kanálu pomocí submit. Při volání příkazu submit se vytvoří objekt , PipelineRun který následně vytvoří StepRun objekty pro každý krok v pracovním postupu.

Příklad odeslání koncového bodu kanálu je následující:


   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint)

Při odesílání koncového bodu kanálu je možné zadat řadu volitelných nastavení. Tady jsou některé z nich:

pipeline_parameters: Parametry spuštění kanálu, slovník {name: value}. Další podrobnosti najdete PipelineParameter v tématu .
parent_run_id: Můžete zadat ID spuštění, které nastaví nadřazené spuštění tohoto spuštění kanálu, což se projeví ve funkci RunHistory. Nadřazené spuštění musí patřit do stejného experimentu jako ten, do kterého se tento kanál odesílá.
pipeline_version: Verze kanálu, která se má spustit.

Příklad odeslání koncového bodu kanálu pomocí těchto nastavení:


   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>",
                                    pipeline_version="0")

Pokud chcete přidat novou verzi PipelineEndpoint, použijte:


   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_endpoint.add(published_pipeline)

Další informace o vytváření a používání koncových bodů kanálu najdete v následujícím poznámkovém bloku: https://aka.ms/pl-ver-endpoint.

Metody

add	Přidejte zadaný kanál do pipelineEndpoint.
add_default	Přidejte zadaný kanál na PipelineEndpoint a nastavte výchozí verzi na přidanou verzi kanálu.
archive	Archivujte koncový bod kanálu.
disable	Nastavte parametr PipelineEndpoint na Zakázáno a není k dispozici ke spuštění.
enable	Nastavte hodnotu PipelineEndpoint na Aktivní a je k dispozici ke spuštění.
get	Získejte hodnotu PipelineEndpoint podle názvu nebo ID. Pokud některý z těchto bodů není zadaný, vyvolá výjimku.
get_all	Získejte všechny aktivní koncové body kanálu v aktuálním pracovním prostoru. Získejte všechny aktivní koncové body kanálu. POZNÁMKA: Tato metoda je zastaralá ve prospěch PipelineEndpoint.list().
get_all_pipelines	Získejte seznam kanálů v PipelineEndpointu. POZNÁMKA: Tato metoda je zastaralá ve prospěch list_pipelines()
get_all_versions	Získejte seznam kanálů a odpovídajících verzí v PipelineEndpointu. POZNÁMKA: Tato metoda je zastaralá ve prospěch list_versions()
get_default_version	Získejte výchozí verzi PipelineEndpointu.
get_pipeline	Získat kanál zadané verze nebo výchozí; vyvolá výjimku, pokud není nalezena verze.
list	Vypíše aktivní koncové body kanálu v aktuálním pracovním prostoru.
list_pipelines	Získejte seznam kanálů přidružených k koncovému bodu kanálu.
list_versions	Získejte seznam kanálů a odpovídající verze koncového bodu kanálu.
publish	Vytvořte koncový bod kanálu se zadaným názvem a kanálem nebo publikovaným kanálem. Koncový bod kanálu je rozhraní REST API, které je možné použít z externích aplikací. Informace o ověřování při volání koncových bodů REST najdete v tématu https://aka.ms/pl-restep-auth. Další informace o práci s koncovými body kanálu najdete v tématu https://aka.ms/pl-first-pipeline. Vyvolá výjimku, pokud již existuje koncový bod kanálu s daným názvem.
reactivate	Opětovná aktivace koncového bodu kanálu, který byl archivován.
set_default	Nastavení výchozí verze PipelineEndpoint vyvolá výjimku, pokud se zadaný kanál nenajde.
set_default_version	Nastavení výchozí verze PipelineEndpoint vyvolá výjimku, pokud se zadaná verze nenajde.
set_name	Nastavte název PipelineEndpoint.
submit	Odešlete experiment kanálu dané verze. Pokud verze není žádná, aktivuje výchozí verzi kanálu.

add

Přidejte zadaný kanál do pipelineEndpoint.

add(pipeline)

Parametry

Name	Description
pipeline Vyžadováno	PublishedPipeline Publikovaný kanál, který chcete přidat.

add_default

Přidejte zadaný kanál na PipelineEndpoint a nastavte výchozí verzi na přidanou verzi kanálu.

add_default(pipeline)

Parametry

Name	Description
pipeline Vyžadováno	PublishedPipeline Publikovaný kanál, který se má přidat jako výchozí verze.

disable

Nastavte parametr PipelineEndpoint na Zakázáno a není k dispozici ke spuštění.

disable()

enable

Nastavte hodnotu PipelineEndpoint na Aktivní a je k dispozici ke spuštění.

enable()

get

Získejte hodnotu PipelineEndpoint podle názvu nebo ID. Pokud některý z těchto bodů není zadaný, vyvolá výjimku.

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

Parametry

Name	Description
workspace Vyžadováno	Workspace Pracovní prostor, ve který byl vytvořen PipelineEndpoint.
id	str ID koncového bodu kanálu. Default value: None
name	str Název koncového bodu kanálu. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Poskytovatel pracovního postupu. Default value: None
_service_endpoint	str Koncový bod služby. Default value: None

Návraty

Typ	Description
PipelineEndpoint	Objekt PipelineEndpoint.

get_all

Získejte všechny aktivní koncové body kanálu v aktuálním pracovním prostoru.

Získejte všechny aktivní koncové body kanálu. POZNÁMKA: Tato metoda je zastaralá ve prospěch PipelineEndpoint.list().

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

Parametry

Name	Description
workspace Vyžadováno	Workspace Pracovní prostor.
active_only	bool Pokud je pravda, vrátí pouze body PipelineEndpoints, které jsou aktuálně aktivní. Default value: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Poskytovatel pracovního postupu. Default value: None
_service_endpoint	str Koncový bod služby. Default value: None

Návraty

Typ	Description
list	Seznam PipelineEndpoint objektů.

get_all_pipelines

Získejte seznam kanálů v PipelineEndpointu.

POZNÁMKA: Tato metoda je zastaralá ve prospěch list_pipelines()

get_all_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Parametry

Name	Description
active_only	bool Příznakem vrátíte pouze aktivní kanály. Default value: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Poskytovatel pracovního postupu. Default value: None
_service_endpoint	str Koncový bod služby. Default value: None

Návraty

Typ	Description
list	Seznam PublishedPipeline objektů.

get_all_versions

Získejte seznam kanálů a odpovídajících verzí v PipelineEndpointu.

POZNÁMKA: Tato metoda je zastaralá ve prospěch list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parametry

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Poskytovatel pracovního postupu. Default value: None
_service_endpoint	str Koncový bod služby. Default value: None

Návraty

Typ	Description
list	Seznam PipelineVersion objektů.

get_default_version

Získejte výchozí verzi PipelineEndpointu.

get_default_version()

Návraty

Typ	Description
str	Výchozí verze koncového bodu kanálu

get_pipeline

Získat kanál zadané verze nebo výchozí; vyvolá výjimku, pokud není nalezena verze.

get_pipeline(version=None)

Parametry

Name	Description
version	str Verze kanálu, která se má vrátit. Default value: None

Návraty

Typ	Description
PublishedPipeline	Publikovaný kanál.

list

Vypíše aktivní koncové body kanálu v aktuálním pracovním prostoru.

static list(workspace, active_only=True, max_results=100, _workflow_provider=None, _service_endpoint=None)

Parametry

Name	Description
workspace Vyžadováno	Workspace Pracovní prostor.
active_only	bool Pokud má hodnotu true, vrátí pouze koncové body kanálu, které jsou aktuálně aktivní. Default value: True
max_results	int maximální počet řádků vrácených koncových bodů kanálu Default value: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Zprostředkovatel pracovního postupu. Default value: None
_service_endpoint	str Koncový bod služby. Default value: None

Návraty

Typ	Description
list	Seznam PipelineEndpoint objektů.

list_pipelines

Získejte seznam kanálů přidružených k koncovému bodu kanálu.

list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Parametry

Name	Description
active_only	bool Určuje, jestli se mají vrátit pouze aktivní kanály. Default value: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Zprostředkovatel pracovního postupu. Default value: None
_service_endpoint	str Koncový bod služby. Default value: None

Návraty

Typ	Description
list	Seznam PublishedPipeline objektů.

list_versions

Získejte seznam kanálů a odpovídající verze koncového bodu kanálu.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parametry

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Zprostředkovatel pracovního postupu. Default value: None
_service_endpoint	str Koncový bod služby. Default value: None

Návraty

Typ	Description
list	Seznam PipelineVersion objektů.

publish

Vytvořte koncový bod kanálu se zadaným názvem a kanálem nebo publikovaným kanálem.

Koncový bod kanálu je rozhraní REST API, které je možné použít z externích aplikací. Informace o ověřování při volání koncových bodů REST najdete v tématu https://aka.ms/pl-restep-auth.

Další informace o práci s koncovými body kanálu najdete v tématu https://aka.ms/pl-first-pipeline.

Vyvolá výjimku, pokud již existuje koncový bod kanálu s daným názvem.

static publish(workspace, name, description, pipeline, _workflow_provider=None, _service_endpoint=None)

Parametry

Name	Description
workspace Vyžadováno	Workspace Pracovní prostor pro vytvoření koncového bodu kanálu.
name Vyžadováno	str Název koncového bodu kanálu.
description Vyžadováno	str Popis koncového bodu kanálu.
pipeline Vyžadováno	PublishedPipeline nebo Pipeline Publikovaný kanál nebo kanál
_service_endpoint	str Koncový bod služby. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Zprostředkovatel pracovního postupu. Default value: None

Návraty

Typ	Description
PipelineEndpoint	Nový koncový bod kanálu.

Výjimky

Typ	Description
ValueError

reactivate

Opětovná aktivace koncového bodu kanálu, který byl archivován.

reactivate(name)

Parametry

Name	Description
name Vyžadováno	str Název, který chcete nastavit.

Návraty

Typ	Description
PipelineEndpoint	Objekt PipelineEndpoint.

set_default

Nastavení výchozí verze PipelineEndpoint vyvolá výjimku, pokud se zadaný kanál nenajde.

set_default(pipeline)

Parametry

Name	Description
pipeline Vyžadováno	PublishedPipeline Publikovaný kanál, který se nastaví jako výchozí.

Výjimky

Typ	Description
ValueError

set_default_version

Nastavení výchozí verze PipelineEndpoint vyvolá výjimku, pokud se zadaná verze nenajde.

set_default_version(version)

Parametry

Name	Description
version Vyžadováno	str Verze, která se má nastavit jako výchozí v sadě PipelineEndpoint.

Výjimky

Typ	Description
ValueError

set_name

Nastavte název PipelineEndpoint.

set_name(name)

Parametry

Name	Description
name Vyžadováno	str Název, který chcete nastavit.

submit

Odešlete experiment kanálu dané verze. Pokud verze není žádná, aktivuje výchozí verzi kanálu.

submit(experiment_name, pipeline_parameters=None, parent_run_id=None, pipeline_version=None)

Parametry

Name	Description
experiment_name Vyžadováno	str Název experimentu, do který se má kanál odeslat.
pipeline_parameters	dict Parametry, které se mají použít při provádění kanálu, se předávají jako slovník {name: value}. Další podrobnosti najdete PipelineParameter v tématu . Default value: None
parent_run_id	str Můžete zadat ID spuštění pro nastavení nadřazeného spuštění tohoto spuštění kanálu, což se projeví v runHistory. Nadřazené spuštění musí patřit do stejného experimentu, do kterého se tento kanál odesílá. Default value: None
pipeline_version	str Verze kanálu, která se má spustit. Default value: None

Návraty

Typ	Description
PipelineRun	Odeslaný kanál se spustí.

Výjimky

Typ	Description
ValueError

Atributy

default_version

Získejte výchozí verzi pipelineEndpointu.

Návraty

Typ	Description
str	Výchozí verze.

description

Získejte popis koncového bodu kanálu.

Návraty

Typ	Description
str	Popis.

endpoint

Získejte adresu URL koncového bodu REST koncového bodu kanálu.

Koncový bod je možné použít k aktivaci spuštění kanálu.

Návraty

Typ	Description
str	Koncový bod REST pro PipelineEndpoint ke spuštění kanálu

id

Získejte ID koncového bodu kanálu.

Návraty

Typ	Description
str	ID koncového bodu kanálu.

name

Získejte název bodu PipelineEndpoint.

Návraty

Typ	Description
str	Název

pipeline_version_list

Získejte seznam verzí kanálu.

Návraty

Typ	Description
list	Seznam PipelineIdVersion objektů.

status

Získejte stav koncového bodu kanálu.

Návraty

Typ	Description
str	Stav.

swaggerurl

Získejte adresu URL REST Swaggeru pipelineEndpointu.

Adresa URL Swaggeru může být zobrazení schématu koncového bodu kanálu.

Návraty

Typ	Description
str	REST Swagger pro PipelineEndpoint ke spuštění kanálu.

Sdílet prostřednictvím

PipelineEndpoint Třída

Konstruktor

Parametry

Poznámky

Metody

add

Parametry

add_default

Parametry

archive

disable

enable

get

Parametry

Návraty

get_all

Parametry

Návraty

get_all_pipelines

Parametry

Návraty

get_all_versions

Parametry

Návraty

get_default_version

Návraty

get_pipeline

Parametry

Návraty

list

Parametry

Návraty

list_pipelines

Parametry

Návraty

list_versions

Parametry

Návraty

publish

Parametry

Návraty

Výjimky

reactivate

Parametry

Návraty

set_default

Parametry

Výjimky

set_default_version

Parametry

Výjimky

set_name

Parametry

submit

Parametry

Návraty

Výjimky

Atributy

default_version

Návraty

description

Návraty

endpoint

Návraty

id

Návraty

name

Návraty

pipeline_version_list

Návraty

status

Návraty

swaggerurl

Návraty

Váš názor

Další materiály