PipelineEndpoint Klas

Referentie

Vertegenwoordigt een Pipeline werkstroom die kan worden geactiveerd vanuit een unieke eindpunt-URL.

PipelineEndpoints kunnen worden gebruikt om nieuwe versies van een PublishedPipeline te maken met hetzelfde eindpunt. PipelineEndpoints hebben een unieke naam binnen een werkruimte.

Met behulp van het eindpuntkenmerk van een PipelineEndpoint-object kunt u nieuwe pijplijnuitvoeringen activeren vanuit externe toepassingen met REST-aanroepen. Zie voor informatie over het verifiëren bij het aanroepen van REST-eindpunten https://aka.ms/pl-restep-auth.

Zie voor meer informatie over het maken en uitvoeren van machine learning-pijplijnen https://aka.ms/pl-first-pipeline.

Initialiseer PipelineEndpoint.

Overname: builtins.object

PipelineEndpoint

Constructor

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

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte waarin het PipelineEndpoint is gedefinieerd.
id Vereist	str De id van het PipelineEndpoint.
name Vereist	str De naam van het PipelineEndpoint.
description Vereist	str De beschrijving van het PipelineEndpoint.
status Vereist	str De nieuwe status van het PipelineEndpoint: 'Actief' of 'Uitgeschakeld'.
default_version Vereist	str De standaardversie van de pijplijn in PipelineEndpoint, automatische stappen, begint met '0'.
endpoint Vereist	str De REST-eindpunt-URL voor pipelineEndpoint, die kan worden gebruikt om pijplijnuitvoeringen te verzenden.
pipeline_version_list Vereist	list De lijst met PipelineIdVersion objecten.
_pipeline_endpoint_provider Vereist	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> De PipelineEndpoint-provider.
_pipeline_endpoint_provider Vereist	De PublishedPipeline-provider.
workspace Vereist	Workspace Het werkruimteobject waartoe dit PipelineEndpoint behoort.
id Vereist	str De id van het PipelineEndpoint.
name Vereist	str De naam van het PipelineEndpoint.
description Vereist	str De beschrijving van het PipelineEndpoint.
status Vereist	str De nieuwe status van het PipelineEndpoint: 'Actief' of 'Uitgeschakeld'.
default_version Vereist	str De standaardversie van de pijplijn in PipelineEndpoint, automatische stappen, begint met '0'
endpoint Vereist	str De REST-eindpunt-URL voor PipelineEndpoint om pijplijnuitvoeringen te verzenden.
pipeline_version_list Vereist	list De lijst met PipelineIdVersion
_pipeline_endpoint_provider Vereist	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> De PipelineEndpoint-provider.
_pipeline_endpoint_provider Vereist	De PublishedPipeline-provider.
swaggerendpoint Vereist	De Swagger REST-eindpunt-URL voor PipelineEndpoint om pijplijnuitvoeringen te verzenden.

Opmerkingen

Een PipelineEndpoint kan worden gemaakt op basis van een Pipeline of een PublishedPipeline.

Een voorbeeld om te publiceren vanuit een pijplijn of PublishedPipeline is als volgt:


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

Dien een PipelineEndpoint in met behulp van submit. Wanneer verzenden wordt aangeroepen, wordt er een PipelineRun gemaakt die op zijn beurt objecten maakt StepRun voor elke stap in de werkstroom.

Een voorbeeld van het verzenden van een PipelineEndpoint is als volgt:


   from azureml.pipeline.core import PipelineEndpoint

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

Er zijn een aantal optionele instellingen die kunnen worden opgegeven bij het verzenden van een PipelineEndpoint. Deze omvatten:

pipeline_parameters: Parameters voor pijplijnuitvoering, woordenlijst van {name: value}. Zie PipelineParameter voor meer informatie.
parent_run_id: u kunt een uitvoerings-id opgeven om de bovenliggende uitvoering van deze pijplijnuitvoering in te stellen. Dit wordt weergegeven in RunHistory. De bovenliggende uitvoering moet deel uitmaken van hetzelfde experiment als het experiment waar deze pijplijn naar wordt verzonden.
pipeline_version: de pijplijnversie die moet worden uitgevoerd.

Een voorbeeld om een PipelineEndpoint te verzenden met behulp van deze instellingen is als volgt:


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

Ga als volgt te werk om een nieuwe versie van een PipelineEndpoint toe te voegen:


   from azureml.pipeline.core import PipelineEndpoint

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

Zie het volgende notebook voor meer informatie over het maken en gebruiken van PipelineEndpoints: https://aka.ms/pl-ver-endpoint.

Methoden

add	Voeg de opgegeven pijplijn toe aan PipelineEndpoint.
add_default	Voeg de opgegeven pijplijn toe aan PipelineEndpoint en stel de standaardversie in op toegevoegde pijplijnversie.
archive	Archiveer het PipelineEndpoint.
disable	Stel PipelineEndpoint in op Uitgeschakeld en niet beschikbaar om uit te voeren.
enable	Stel PipelineEndpoint in op Actief en beschikbaar om uit te voeren.
get	Haal het PipelineEndpoint op op naam of id, genereert een uitzondering als een van beide niet is opgegeven.
get_all	Alle actieve PipelineEndpoints ophalen in de huidige werkruimte. Alle actieve PipelineEndpoints ophalen. OPMERKING: deze methode wordt afgeschaft ten gunste van PipelineEndpoint.list().
get_all_pipelines	Haal een lijst met pijplijnen op in PipelineEndpoint. OPMERKING: deze methode wordt afgeschaft ten gunste van list_pipelines()
get_all_versions	Haal een lijst met pijplijnen en bijbehorende versies op in PipelineEndpoint. OPMERKING: deze methode wordt afgeschaft ten gunste van list_versions()
get_default_version	Haal de standaardversie van PipelineEndpoint op.
get_pipeline	Haal de pijplijn van een opgegeven versie of de standaardversie op; genereert een uitzondering als de versie niet wordt gevonden.
list	Actieve PipelineEndpoints weergeven in de huidige werkruimte.
list_pipelines	Haal een lijst op met pijplijnen die zijn gekoppeld aan het PipelineEndpoint.
list_versions	Een lijst met pijplijnen en bijbehorende versies van pipelineEndpoint ophalen.
publish	Maak een PipelineEndpoint met de opgegeven naam en pijplijn/gepubliceerde pijplijn. Het pijplijneindpunt is een REST API die kan worden gebruikt vanuit externe toepassingen. Zie voor informatie over het verifiëren bij het aanroepen van REST-eindpunten https://aka.ms/pl-restep-auth. Zie voor meer informatie over het werken met pijplijneindpunten https://aka.ms/pl-first-pipeline. Genereert uitzondering als er al een PipelineEndpoint met de opgegeven naam bestaat.
reactivate	Een PipelineEndpoint dat is gearchiveerd, opnieuw activeren.
set_default	Stel de standaardversie van PipelineEndpoint in, genereert een uitzondering als de opgegeven pijplijn niet wordt gevonden.
set_default_version	Stel de standaardversie van PipelineEndpoint in, genereert een uitzondering als de opgegeven versie niet wordt gevonden.
set_name	Stel de naam van PipelineEndpoint in.
submit	Dien een pijplijnexperiment van een bepaalde versie in; Als de versie geen is, wordt de standaardversie van de pijplijn geactiveerd.

add

Voeg de opgegeven pijplijn toe aan PipelineEndpoint.

add(pipeline)

Parameters

Name	Description
pipeline Vereist	PublishedPipeline Een gepubliceerde pijplijn om toe te voegen.

add_default

Voeg de opgegeven pijplijn toe aan PipelineEndpoint en stel de standaardversie in op toegevoegde pijplijnversie.

add_default(pipeline)

Parameters

Name	Description
pipeline Vereist	PublishedPipeline Een gepubliceerde pijplijn om toe te voegen als de standaardversie.

disable

Stel PipelineEndpoint in op Uitgeschakeld en niet beschikbaar om uit te voeren.

disable()

enable

Stel PipelineEndpoint in op Actief en beschikbaar om uit te voeren.

enable()

get

Haal het PipelineEndpoint op op naam of id, genereert een uitzondering als een van beide niet is opgegeven.

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

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte waarin het PipelineEndpoint is gemaakt.
id	str De id van het PipelineEndpoint. Default value: None
name	str De naam van het PipelineEndpoint. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> De werkstroomprovider. Default value: None
_service_endpoint	str Het service-eindpunt. Default value: None

Retouren

Type	Description
PipelineEndpoint	Het object PipelineEndpoint.

get_all

Alle actieve PipelineEndpoints ophalen in de huidige werkruimte.

Alle actieve PipelineEndpoints ophalen. OPMERKING: deze methode wordt afgeschaft ten gunste van PipelineEndpoint.list().

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

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte.
active_only	bool Als dit waar is, retourneert u alleen PipelineEndpoints die momenteel actief zijn. Default value: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> De werkstroomprovider. Default value: None
_service_endpoint	str Het service-eindpunt. Default value: None

Retouren

Type	Description
list	De lijst met PipelineEndpoint objecten.

get_all_pipelines

Haal een lijst met pijplijnen op in PipelineEndpoint.

OPMERKING: deze methode wordt afgeschaft ten gunste van list_pipelines()

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

Parameters

Name	Description
active_only	bool Vlag om alleen actieve pijplijnen te retourneren. Default value: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> De werkstroomprovider. Default value: None
_service_endpoint	str Het service-eindpunt. Default value: None

Retouren

Type	Description
list	De lijst met PublishedPipeline objecten.

get_all_versions

Haal een lijst met pijplijnen en bijbehorende versies op in PipelineEndpoint.

OPMERKING: deze methode wordt afgeschaft ten gunste van list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> De werkstroomprovider. Default value: None
_service_endpoint	str Het service-eindpunt. Default value: None

Retouren

Type	Description
list	De lijst met PipelineVersion objecten.

get_default_version

Haal de standaardversie van PipelineEndpoint op.

get_default_version()

Retouren

Type	Description
str	De standaardversie van het pijplijneindpunt.

get_pipeline

Haal de pijplijn van een opgegeven versie of de standaardversie op; genereert een uitzondering als de versie niet wordt gevonden.

get_pipeline(version=None)

Parameters

Name	Description
version	str De versie van de pijplijn die moet worden geretourneerd. Default value: None

Retouren

Type	Description
PublishedPipeline	Een gepubliceerde pijplijn.

list

Actieve PipelineEndpoints weergeven in de huidige werkruimte.

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

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte.
active_only	bool Als dit waar is, retourneert u alleen PipelineEndpoints die momenteel actief zijn. Default value: True
max_results	int maximum aantal regels van geretourneerde PipelineEndpoints Default value: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> De werkstroomprovider. Default value: None
_service_endpoint	str Het service-eindpunt. Default value: None

Retouren

Type	Description
list	De lijst met PipelineEndpoint objecten.

list_pipelines

Haal een lijst op met pijplijnen die zijn gekoppeld aan het PipelineEndpoint.

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

Parameters

Name	Description
active_only	bool Geeft aan of alleen actieve pijplijnen moeten worden geretourneerd. Default value: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> De werkstroomprovider. Default value: None
_service_endpoint	str Het service-eindpunt. Default value: None

Retouren

Type	Description
list	De lijst met PublishedPipeline objecten.

list_versions

Een lijst met pijplijnen en bijbehorende versies van pipelineEndpoint ophalen.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parameters

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> De werkstroomprovider. Default value: None
_service_endpoint	str Het service-eindpunt. Default value: None

Retouren

Type	Description
list	De lijst met PipelineVersion objecten.

publish

Maak een PipelineEndpoint met de opgegeven naam en pijplijn/gepubliceerde pijplijn.

Het pijplijneindpunt is een REST API die kan worden gebruikt vanuit externe toepassingen. Zie voor informatie over het verifiëren bij het aanroepen van REST-eindpunten https://aka.ms/pl-restep-auth.

Zie voor meer informatie over het werken met pijplijneindpunten https://aka.ms/pl-first-pipeline.

Genereert uitzondering als er al een PipelineEndpoint met de opgegeven naam bestaat.

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

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte waarin u het PipelineEndpoint wilt maken.
name Vereist	str De naam van het PipelineEndpoint.
description Vereist	str De beschrijving van het PipelineEndpoint.
pipeline Vereist	PublishedPipeline of Pipeline De gepubliceerde pijplijn of pijplijn.
_service_endpoint	str Het service-eindpunt. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> De werkstroomprovider. Default value: None

Retouren

Type	Description
PipelineEndpoint	Een nieuw PipelineEndpoint.

Uitzonderingen

Type	Description
ValueError

reactivate

Een PipelineEndpoint dat is gearchiveerd, opnieuw activeren.

reactivate(name)

Parameters

Name	Description
name Vereist	str De naam die moet worden ingesteld.

Retouren

Type	Description
PipelineEndpoint	Een PipelineEndpoint-object.

set_default

Stel de standaardversie van PipelineEndpoint in, genereert een uitzondering als de opgegeven pijplijn niet wordt gevonden.

set_default(pipeline)

Parameters

Name	Description
pipeline Vereist	PublishedPipeline De gepubliceerde pijplijn die als standaard moet worden ingesteld.

Uitzonderingen

Type	Description
ValueError

set_default_version

Stel de standaardversie van PipelineEndpoint in, genereert een uitzondering als de opgegeven versie niet wordt gevonden.

set_default_version(version)

Parameters

Name	Description
version Vereist	str De versie die moet worden ingesteld als de standaardversie in PipelineEndpoint.

Uitzonderingen

Type	Description
ValueError

set_name

Stel de naam van PipelineEndpoint in.

set_name(name)

Parameters

Name	Description
name Vereist	str De naam die moet worden ingesteld.

submit

Dien een pijplijnexperiment van een bepaalde versie in; Als de versie geen is, wordt de standaardversie van de pijplijn geactiveerd.

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

Parameters

Name	Description
experiment_name Vereist	str De naam van het experiment waarin de pijplijn moet worden verzonden.
pipeline_parameters	dict Parameters die moeten worden gebruikt bij de uitvoering van de pijplijn, doorgegeven als een woordenlijst van {name: value}. Zie PipelineParameter voor meer informatie. Default value: None
parent_run_id	str U kunt een uitvoerings-id opgeven om de bovenliggende uitvoering van deze pijplijnuitvoering in te stellen, wat wordt weergegeven in RunHistory. De bovenliggende uitvoering moet deel uitmaken van hetzelfde experiment als datgene waar deze pijplijn naar wordt verzonden. Default value: None
pipeline_version	str De versie van de pijplijn die moet worden uitgevoerd. Default value: None

Retouren

Type	Description
PipelineRun	De verzonden pijplijnuitvoering.

Uitzonderingen

Type	Description
ValueError

Kenmerken

default_version

Haal de standaardversie van PipelineEndpoint op.

Retouren

Type	Description
str	De standaardversie.

description

Haal de beschrijving van het PipelineEndpoint op.

Retouren

Type	Description
str	De beschrijving.

endpoint

Haal de REST-eindpunt-URL van het PipelineEndpoint op.

Het eindpunt kan worden gebruikt om uitvoeringen van de pijplijn te activeren.

Retouren

Type	Description
str	REST-eindpunt voor PipelineEndpoint om pijplijn uit te voeren.

id

Haal de id van het PipelineEndpoint op.

Retouren

Type	Description
str	De id van het PipelineEndpoint.

name

Haal de naam van het PipelineEndpoint op.

Retouren

Type	Description
str	De naam.

pipeline_version_list

Haal de lijst met pijplijnversies op.

Retouren

Type	Description
list	De lijst met PipelineIdVersion objecten.

status

Haal de status van het PipelineEndpoint op.

Retouren

Type	Description
str	De status.

swaggerurl

Haal de REST Swagger-URL van het PipelineEndpoint op.

De Swagger-URL kan het schema van het pijplijneindpunt weergeven.

Retouren

Type	Description
str	REST Swagger voor PipelineEndpoint om pijplijn uit te voeren.

Delen via

PipelineEndpoint Klas

Constructor

Parameters

Opmerkingen

Methoden

add

Parameters

add_default

Parameters

archive

disable

enable

get

Parameters

Retouren

get_all

Parameters

Retouren

get_all_pipelines

Parameters

Retouren

get_all_versions

Parameters

Retouren

get_default_version

Retouren

get_pipeline

Parameters

Retouren

list

Parameters

Retouren

list_pipelines

Parameters

Retouren

list_versions

Parameters

Retouren

publish

Parameters

Retouren

Uitzonderingen

reactivate

Parameters

Retouren

set_default

Parameters

Uitzonderingen

set_default_version

Parameters

Uitzonderingen

set_name

Parameters

submit

Parameters

Retouren

Uitzonderingen

Kenmerken

default_version

Retouren

description

Retouren

endpoint

Retouren

id

Retouren

name

Retouren

pipeline_version_list

Retouren

status

Retouren

swaggerurl

Retouren

Feedback

Aanvullende resources