PipelineEndpoint Klass

Referens

Representerar ett Pipeline arbetsflöde som kan utlösas från en unik slutpunkts-URL.

PipelineEndpoints kan användas för att skapa nya versioner av en PublishedPipeline samtidigt som samma slutpunkt bibehålls. PipelineEndpoints namnges unikt på en arbetsyta.

Med hjälp av slutpunktsattributet för ett PipelineEndpoint-objekt kan du utlösa nya pipelinekörningar från externa program med REST-anrop. Information om hur du autentiserar när du anropar REST-slutpunkter finns i https://aka.ms/pl-restep-auth.

Mer information om hur du skapar och kör maskininlärningspipelines finns i https://aka.ms/pl-first-pipeline.

Initiera PipelineEndpoint.

Arv: 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)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan PipelineEndpoint definieras i.
id Obligatorisk	str ID för PipelineEndpoint.
name Obligatorisk	str Namnet på PipelineEndpoint.
description Obligatorisk	str Beskrivningen av PipelineEndpoint.
status Obligatorisk	str Den nya statusen för PipelineEndpoint: "Aktiv" eller "Inaktiverad".
default_version Obligatorisk	str Standardversionen av pipelinen i PipelineEndpoint, automatisk ökning, börjar med "0".
endpoint Obligatorisk	str REST-slutpunkts-URL:en för PipelineEndpoint, som kan användas för att skicka pipelinekörningar.
pipeline_version_list Obligatorisk	list Listan över PipelineIdVersion objekt.
_pipeline_endpoint_provider Obligatorisk	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> PipelineEndpoint-providern.
_pipeline_endpoint_provider Obligatorisk	PublishedPipeline-providern.
workspace Obligatorisk	Workspace Arbetsyteobjektet som PipelineEndpoint kommer att tillhöra.
id Obligatorisk	str ID för PipelineEndpoint.
name Obligatorisk	str Namnet på PipelineEndpoint.
description Obligatorisk	str Beskrivningen av PipelineEndpoint.
status Obligatorisk	str Den nya statusen för PipelineEndpoint: "Aktiv" eller "Inaktiverad".
default_version Obligatorisk	str Standardversionen av pipelinen i PipelineEndpoint, automatisk ökning, börjar med "0"
endpoint Obligatorisk	str REST-slutpunkts-URL:en för PipelineEndpoint för att skicka pipelinekörningar.
pipeline_version_list Obligatorisk	list Listan över PipelineIdVersion
_pipeline_endpoint_provider Obligatorisk	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> PipelineEndpoint-providern.
_pipeline_endpoint_provider Obligatorisk	PublishedPipeline-providern.
swaggerendpoint Obligatorisk	Swagger REST-slutpunkts-URL:en för PipelineEndpoint för att skicka pipelinekörningar.

Kommentarer

En PipelineEndpoint kan skapas från antingen en Pipeline eller en PublishedPipeline.

Ett exempel på publicering från en pipeline eller PublishedPipeline är följande:


   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")

Skicka en PipelineEndpoint med .submit När skicka anropas skapas en PipelineRun som i sin tur skapar StepRun objekt för varje steg i arbetsflödet.

Ett exempel på hur du skickar en PipelineEndpoint är följande:


   from azureml.pipeline.core import PipelineEndpoint

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

Det finns ett antal valfria inställningar som kan anges när du skickar en PipelineEndpoint. Dessa omfattar:

pipeline_parameters: Parametrar för pipelinekörning, ordlista med {name: value}. Mer PipelineParameter information finns i.
parent_run_id: Du kan ange ett körnings-ID för att ange den överordnade körningen av den här pipelinekörningen, vilket visas i RunHistory. Den överordnade körningen måste tillhöra samma experiment som den som pipelinen skickas till.
pipeline_version: Pipelineversionen som ska köras.

Ett exempel på hur du skickar en PipelineEndpoint med de här inställningarna är följande:


   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")

Så här lägger du till en ny version av en PipelineEndpoint-användning:


   from azureml.pipeline.core import PipelineEndpoint

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

Mer information om hur du skapar och använder PipelineEndpoints finns i följande notebook-fil: https://aka.ms/pl-ver-endpoint.

Metoder

add	Lägg till den angivna pipelinen i PipelineEndpoint.
add_default	Lägg till den angivna pipelinen i PipelineEndpoint och ange standardversionen till den tillagda pipelineversionen.
archive	Arkivera PipelineEndpoint.
disable	Ange PipelineEndpoint till "Inaktiverad" och otillgänglig att köra.
enable	Ange PipelineEndpoint till "Aktiv" och tillgänglig för körning.
get	Hämta PipelineEndpoint efter namn eller ID, genererar undantag om någon av dem inte har angetts.
get_all	Hämta alla aktiva PipelineEndpoints i den aktuella arbetsytan. Hämta alla aktiva PipelineEndpoints. Obs! Den här metoden håller på att bli inaktuell till förmån för PipelineEndpoint.list().
get_all_pipelines	Hämta en lista över pipelines i PipelineEndpoint. Obs! Den här metoden är inaktuell till förmån för list_pipelines()
get_all_versions	Hämta en lista över pipelines och motsvarande versioner i PipelineEndpoint. Obs! Den här metoden är inaktuell till förmån för list_versions()
get_default_version	Hämta standardversionen av PipelineEndpoint.
get_pipeline	Hämta pipelinen för en angiven version eller standard. genererar ett undantag om versionen inte hittas.
list	Visa en lista över aktiva PipelineEndpoints i den aktuella arbetsytan.
list_pipelines	Hämta en lista över pipelines som är associerade med PipelineEndpoint.
list_versions	Hämta en lista över pipelines och motsvarande versioner av PipelineEndpoint.
publish	Skapa en PipelineEndpoint med det angivna namnet och pipelinen/den publicerade pipelinen. Pipelineslutpunkten är ett REST-API som kan användas från externa program. Information om hur du autentiserar när du anropar REST-slutpunkter finns i https://aka.ms/pl-restep-auth. Mer information om hur du arbetar med pipelineslutpunkter finns i https://aka.ms/pl-first-pipeline. Genererar undantag om det redan finns en PipelineEndpoint med det angivna namnet.
reactivate	Återaktivera en PipelineEndpoint som arkiverades.
set_default	Ange standardversionen av PipelineEndpoint och utlöser ett undantag om den angivna pipelinen inte hittas.
set_default_version	Ange standardversionen av PipelineEndpoint och utlöser ett undantag om den angivna versionen inte hittas.
set_name	Ange namnet på PipelineEndpoint.
submit	Skicka ett pipelineexperiment av den angivna versionen; om versionen inte är någon utlöser standardversionen av pipelinen.

add

Lägg till den angivna pipelinen i PipelineEndpoint.

add(pipeline)

Parametrar

Name	Description
pipeline Obligatorisk	PublishedPipeline En publicerad pipeline att lägga till.

add_default

Lägg till den angivna pipelinen i PipelineEndpoint och ange standardversionen till den tillagda pipelineversionen.

add_default(pipeline)

Parametrar

Name	Description
pipeline Obligatorisk	PublishedPipeline En publicerad pipeline som ska läggas till som standardversion.

disable

Ange PipelineEndpoint till "Inaktiverad" och otillgänglig att köra.

disable()

enable

Ange PipelineEndpoint till "Aktiv" och tillgänglig för körning.

enable()

get

Hämta PipelineEndpoint efter namn eller ID, genererar undantag om någon av dem inte har angetts.

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

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan pipelineEndpoint skapades i.
id	str ID för PipelineEndpoint. Standardvärde: None
name	str Namnet på PipelineEndpoint. Standardvärde: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Arbetsflödesprovidern. Standardvärde: None
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None

Returer

Typ	Description
PipelineEndpoint	PipelineEndpoint-objektet.

get_all

Hämta alla aktiva PipelineEndpoints i den aktuella arbetsytan.

Hämta alla aktiva PipelineEndpoints. Obs! Den här metoden håller på att bli inaktuell till förmån för PipelineEndpoint.list().

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

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan.
active_only	bool Om det är sant returnerar du endast PipelineEndpoints som för närvarande är aktiva. Standardvärde: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Arbetsflödesprovidern. Standardvärde: None
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None

Returer

Typ	Description
list	Listan över PipelineEndpoint objekt.

get_all_pipelines

Hämta en lista över pipelines i PipelineEndpoint.

Obs! Den här metoden är inaktuell till förmån för list_pipelines()

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

Parametrar

Name	Description
active_only	bool Flagga för att endast returnera aktiva pipelines. Standardvärde: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Arbetsflödesprovidern. Standardvärde: None
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None

Returer

Typ	Description
list	Listan över PublishedPipeline objekt.

get_all_versions

Hämta en lista över pipelines och motsvarande versioner i PipelineEndpoint.

Obs! Den här metoden är inaktuell till förmån för list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parametrar

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Arbetsflödesprovidern. Standardvärde: None
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None

Returer

Typ	Description
list	Listan över PipelineVersion objekt.

get_default_version

Hämta standardversionen av PipelineEndpoint.

get_default_version()

Returer

Typ	Description
str	Standardversionen av pipelineslutpunkten.

get_pipeline

Hämta pipelinen för en angiven version eller standard. genererar ett undantag om versionen inte hittas.

get_pipeline(version=None)

Parametrar

Name	Description
version	str Den version av pipelinen som ska returneras. Standardvärde: None

Returer

Typ	Description
PublishedPipeline	En publicerad pipeline.

list

Visa en lista över aktiva PipelineEndpoints i den aktuella arbetsytan.

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

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan.
active_only	bool Om det är sant returnerar du endast PipelineEndpoints som för närvarande är aktiva. Standardvärde: True
max_results	int maximalt antal rader returnerade PipelineEndpoints Standardvärde: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Arbetsflödesprovidern. Standardvärde: None
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None

Returer

Typ	Description
list	Listan över PipelineEndpoint objekt.

list_pipelines

Hämta en lista över pipelines som är associerade med PipelineEndpoint.

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

Parametrar

Name	Description
active_only	bool Anger om endast aktiva pipelines ska returneras. Standardvärde: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Arbetsflödesprovidern. Standardvärde: None
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None

Returer

Typ	Description
list	Listan över PublishedPipeline objekt.

list_versions

Hämta en lista över pipelines och motsvarande versioner av PipelineEndpoint.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parametrar

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Arbetsflödesprovidern. Standardvärde: None
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None

Returer

Typ	Description
list	Listan över PipelineVersion objekt.

publish

Skapa en PipelineEndpoint med det angivna namnet och pipelinen/den publicerade pipelinen.

Pipelineslutpunkten är ett REST-API som kan användas från externa program. Information om hur du autentiserar när du anropar REST-slutpunkter finns i https://aka.ms/pl-restep-auth.

Mer information om hur du arbetar med pipelineslutpunkter finns i https://aka.ms/pl-first-pipeline.

Genererar undantag om det redan finns en PipelineEndpoint med det angivna namnet.

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

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan för att skapa PipelineEndpoint i.
name Obligatorisk	str Namnet på PipelineEndpoint.
description Obligatorisk	str Beskrivning av PipelineEndpoint.
pipeline Obligatorisk	PublishedPipeline eller Pipeline Den publicerade pipelinen eller pipelinen.
_service_endpoint	str Tjänstslutpunkten. Standardvärde: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Arbetsflödesprovidern. Standardvärde: None

Returer

Typ	Description
PipelineEndpoint	En ny PipelineEndpoint.

Undantag

Typ	Description
ValueError

reactivate

Återaktivera en PipelineEndpoint som arkiverades.

reactivate(name)

Parametrar

Name	Description
name Obligatorisk	str Namnet som ska anges.

Returer

Typ	Description
PipelineEndpoint	Ett PipelineEndpoint-objekt.

set_default

Ange standardversionen av PipelineEndpoint och utlöser ett undantag om den angivna pipelinen inte hittas.

set_default(pipeline)

Parametrar

Name	Description
pipeline Obligatorisk	PublishedPipeline Den publicerade pipelinen som ska anges som standard.

Undantag

Typ	Description
ValueError

set_default_version

Ange standardversionen av PipelineEndpoint och utlöser ett undantag om den angivna versionen inte hittas.

set_default_version(version)

Parametrar

Name	Description
version Obligatorisk	str Den version som ska anges som standardversion i PipelineEndpoint.

Undantag

Typ	Description
ValueError

set_name

Ange namnet på PipelineEndpoint.

set_name(name)

Parametrar

Name	Description
name Obligatorisk	str Namnet som ska anges.

submit

Skicka ett pipelineexperiment av den angivna versionen; om versionen inte är någon utlöser standardversionen av pipelinen.

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

Parametrar

Name	Description
experiment_name Obligatorisk	str Namnet på experimentet som pipelinen ska skickas in i.
pipeline_parameters	dict Parametrar som ska användas vid pipelinekörning, som skickas som en ordlista med {name: value}. Mer PipelineParameter information finns i. Standardvärde: None
parent_run_id	str Du kan ange ett körnings-ID för att ange den överordnade körningen av den här pipelinekörningen, vilket visas i RunHistory. Den överordnade körningen måste tillhöra samma experiment som den här pipelinen skickas till. Standardvärde: None
pipeline_version	str Den version av pipelinen som ska köras. Standardvärde: None

Returer

Typ	Description
PipelineRun	Den skickade pipelinekörningen.

Undantag

Typ	Description
ValueError

Attribut

default_version

Hämta standardversionen av PipelineEndpoint.

Returer

Typ	Description
str	Standardversionen.

description

Hämta beskrivningen av PipelineEndpoint.

Returer

Typ	Description
str	Beskrivningen.

endpoint

Hämta REST-slutpunkts-URL:en för PipelineEndpoint.

Slutpunkten kan användas för att utlösa körningar av pipelinen.

Returer

Typ	Description
str	REST-slutpunkt för PipelineEndpoint för att köra pipeline.

id

Hämta ID för PipelineEndpoint.

Returer

Typ	Description
str	ID för PipelineEndpoint.

name

Hämta namnet på PipelineEndpoint.

Returer

Typ	Description
str	Namnet.

pipeline_version_list

Hämta listan över pipelineversioner.

Returer

Typ	Description
list	Listan över PipelineIdVersion objekt.

status

Hämta status för PipelineEndpoint.

Returer

Typ	Description
str	Status.

swaggerurl

Hämta REST Swagger-URL:en för PipelineEndpoint.

Swagger-URL:en kan vara ett schema för pipelineslutpunkten.

Returer

Typ	Description
str	REST Swagger för PipelineEndpoint för att köra pipeline.

Dela via

PipelineEndpoint Klass

Konstruktor

Parametrar

Kommentarer

Metoder

add

Parametrar

add_default

Parametrar

archive

disable

enable

get

Parametrar

Returer

get_all

Parametrar

Returer

get_all_pipelines

Parametrar

Returer

get_all_versions

Parametrar

Returer

get_default_version

Returer

get_pipeline

Parametrar

Returer

list

Parametrar

Returer

list_pipelines

Parametrar

Returer

list_versions

Parametrar

Returer

publish

Parametrar

Returer

Undantag

reactivate

Parametrar

Returer

set_default

Parametrar

Undantag

set_default_version

Parametrar

Undantag

set_name

Parametrar

submit

Parametrar

Returer

Undantag

Attribut

default_version

Returer

description

Returer

endpoint

Returer

id

Returer

name

Returer

pipeline_version_list

Returer

status

Returer

swaggerurl

Returer

Feedback

Ytterligare resurser