PipelineEndpoint Classe

Rappresenta un Pipeline flusso di lavoro che può essere attivato da un URL di endpoint univoco.

PipelineEndpoints può essere usato per creare nuove versioni di un PublishedPipeline oggetto mantenendo lo stesso endpoint. PipelineEndpoints è denominato in modo univoco all'interno di un'area di lavoro.

Usando l'attributo endpoint di un oggetto PipelineEndpoint, è possibile attivare nuove esecuzioni di pipeline da applicazioni esterne con chiamate REST. Per informazioni su come eseguire l'autenticazione quando si chiamano gli endpoint REST, vedere https://aka.ms/pl-restep-auth.

Per altre informazioni sulla creazione e l'esecuzione di pipeline di Machine Learning, vedere https://aka.ms/pl-first-pipeline.

Inizializzare PipelineEndpoint.

Costruttore

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

Parametri

Nome	Descrizione
workspace Necessario	Workspace L'area di lavoro in cui è definito PipelineEndpoint.
id Necessario	str ID di PipelineEndpoint.
name Necessario	str Nome dell'oggetto PipelineEndpoint.
description Necessario	str Descrizione di PipelineEndpoint.
status Necessario	str Nuovo stato di PipelineEndpoint: 'Active' o 'Disabled'.
default_version Necessario	str La versione predefinita della pipeline in PipelineEndpoint, incrementi automatici, inizia con "0".
endpoint Necessario	str URL dell'endpoint REST per PipelineEndpoint, che può essere usato per inviare le esecuzioni della pipeline.
pipeline_version_list Necessario	list Elenco di PipelineIdVersion oggetti.
_pipeline_endpoint_provider Necessario	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Provider PipelineEndpoint.
_pipeline_endpoint_provider Necessario	Provider PublishedPipeline.
workspace Necessario	Workspace Oggetto dell'area di lavoro a cui appartiene PipelineEndpoint.
id Necessario	str ID di PipelineEndpoint.
name Necessario	str Nome dell'oggetto PipelineEndpoint.
description Necessario	str Descrizione di PipelineEndpoint.
status Necessario	str Nuovo stato di PipelineEndpoint: 'Active' o 'Disabled'.
default_version Necessario	str La versione predefinita della pipeline in PipelineEndpoint, incrementi automatici, inizia con "0"
endpoint Necessario	str URL dell'endpoint REST per PipelineEndpoint per inviare le esecuzioni della pipeline.
pipeline_version_list Necessario	list Elenco di PipelineIdVersion
_pipeline_endpoint_provider Necessario	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Provider PipelineEndpoint.
_pipeline_endpoint_provider Necessario	Provider PublishedPipeline.
swaggerendpoint Necessario	URL dell'endpoint REST di Swagger per PipelineEndpoint per inviare le esecuzioni della pipeline.

Commenti

Un oggetto PipelineEndpoint può essere creato da un Pipeline oggetto o da un oggetto PublishedPipeline.

Un esempio di pubblicazione da pipeline o PublishedPipeline è il seguente:

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

Inviare un oggetto PipelineEndpoint usando submit. Quando viene chiamato submit, viene creato un oggetto PipelineRun che a sua volta crea StepRun oggetti per ogni passaggio del flusso di lavoro.

Di seguito è riportato un esempio di come inviare un oggetto PipelineEndpoint:

   from azureml.pipeline.core import PipelineEndpoint

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

Durante l'invio di un oggetto PipelineEndpoint è possibile specificare diverse impostazioni facoltative. Questi includono:

• pipeline_parameters: parametri per l'esecuzione della pipeline, dizionario di {name: value}. Per altri dettagli, vedere PipelineParameter.

• parent_run_id: è possibile specificare un ID esecuzione per impostare l'esecuzione padre di questa pipeline, che si riflette in RunHistory. L'esecuzione padre deve appartenere allo stesso esperimento di quello a cui viene inviata questa pipeline.

• pipeline_version: versione della pipeline da eseguire.

Un esempio per inviare un oggetto PipelineEndpoint usando queste impostazioni è il seguente:

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

Per aggiungere una nuova versione di un oggetto PipelineEndpoint, usare:

   from azureml.pipeline.core import PipelineEndpoint

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

Per altre informazioni sulla creazione e l'uso di PipelineEndpoints, vedere il notebook seguente: https://aka.ms/pl-ver-endpoint.

Metodi

add	Aggiungere la pipeline specificata a PipelineEndpoint.
add_default	Aggiungere la pipeline specificata a PipelineEndpoint e impostare la versione predefinita sulla versione della pipeline aggiunta.
archive	Archiviare PipelineEndpoint.
disable	Impostare PipelineEndpoint su 'Disabled' e non disponibile per l'esecuzione.
enable	Impostare PipelineEndpoint su 'Active' e disponibile per l'esecuzione.
get	Ottenere PipelineEndpoint in base al nome o all'ID, genera un'eccezione se non viene specificato.
get_all	Ottiene tutti i pipelineEndpoint attivi nell'area di lavoro corrente. Ottiene tutti i pipelineEndpoint attivi. NOTA: questo metodo è deprecato a favore di PipelineEndpoint.list().
get_all_pipelines	Ottenere l'elenco delle pipeline in PipelineEndpoint. NOTA: questo metodo è deprecato a favore di list_pipelines()
get_all_versions	Ottenere l'elenco delle pipeline e delle versioni corrispondenti in PipelineEndpoint. NOTA: questo metodo è deprecato a favore di list_versions()
get_default_version	Ottenere la versione predefinita di PipelineEndpoint.
get_pipeline	Ottenere la pipeline di una versione specificata o dell'impostazione predefinita; genera un'eccezione se la versione non viene trovata.
list	Elencare pipelineEndpoint attivi nell'area di lavoro corrente.
list_pipelines	Ottenere un elenco di pipeline associate a PipelineEndpoint.
list_versions	Ottenere un elenco di pipeline e versioni corrispondenti di PipelineEndpoint.
publish	Creare un oggetto PipelineEndpoint con il nome e la pipeline e la pipeline/pubblicata specificati. L'endpoint della pipeline è un'API REST che può essere usata da applicazioni esterne. Per informazioni su come eseguire l'autenticazione quando si chiamano gli endpoint REST, vedere https://aka.ms/pl-restep-auth. Per altre informazioni sull'uso degli endpoint della pipeline, vedere https://aka.ms/pl-first-pipeline. Genera un'eccezione se esiste già un oggetto PipelineEndpoint con il nome specificato.
reactivate	Riattivare un oggetto PipelineEndpoint archiviato.
set_default	Impostare la versione predefinita di PipelineEndpoint, genera un'eccezione se la pipeline specificata non viene trovata.
set_default_version	Impostare la versione predefinita di PipelineEndpoint, genera un'eccezione se la versione specificata non viene trovata.
set_name	Impostare il nome di PipelineEndpoint.
submit	Inviare un esperimento della pipeline di una determinata versione; se la versione è none attiva la versione predefinita della pipeline.

add

Aggiungere la pipeline specificata a PipelineEndpoint.

add(pipeline)

Parametri

Nome	Descrizione
pipeline Necessario	PublishedPipeline Pipeline pubblicata da aggiungere.

add_default

Aggiungere la pipeline specificata a PipelineEndpoint e impostare la versione predefinita sulla versione della pipeline aggiunta.

add_default(pipeline)

Parametri

Nome	Descrizione
pipeline Necessario	PublishedPipeline Pipeline pubblicata da aggiungere come versione predefinita.

archive

Archiviare PipelineEndpoint.

archive()

disable

Impostare PipelineEndpoint su 'Disabled' e non disponibile per l'esecuzione.

disable()

enable

Impostare PipelineEndpoint su 'Active' e disponibile per l'esecuzione.

enable()

get

Ottenere PipelineEndpoint in base al nome o all'ID, genera un'eccezione se non viene specificato.

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

Parametri

Nome	Descrizione
workspace Necessario	Workspace L'area di lavoro in cui è stato creato PipelineEndpoint.
id	str ID di PipelineEndpoint. Valore predefinito: None
name	str Nome dell'oggetto PipelineEndpoint. Valore predefinito: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Provider del flusso di lavoro. Valore predefinito: None
_service_endpoint	str Endpoint del servizio. Valore predefinito: None

Restituisce

Tipo	Descrizione
PipelineEndpoint	Oggetto PipelineEndpoint.

get_all

Ottiene tutti i pipelineEndpoint attivi nell'area di lavoro corrente.

Ottiene tutti i pipelineEndpoint attivi. NOTA: questo metodo è deprecato a favore di PipelineEndpoint.list().

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

Parametri

Nome	Descrizione
workspace Necessario	Workspace Area di lavoro.
active_only	bool Se true, restituisce solo PipelineEndpoints attualmente attivi. Valore predefinito: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Provider del flusso di lavoro. Valore predefinito: None
_service_endpoint	str Endpoint del servizio. Valore predefinito: None

Restituisce

Tipo	Descrizione
list	Elenco di PipelineEndpoint oggetti.

get_all_pipelines

Ottenere l'elenco delle pipeline in PipelineEndpoint.

NOTA: questo metodo è deprecato a favore di list_pipelines()

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

Parametri

Nome	Descrizione
active_only	bool Flag per restituire solo le pipeline attive. Valore predefinito: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Provider del flusso di lavoro. Valore predefinito: None
_service_endpoint	str Endpoint del servizio. Valore predefinito: None

Restituisce

Tipo	Descrizione
list	Elenco di PublishedPipeline oggetti.

get_all_versions

Ottenere l'elenco delle pipeline e delle versioni corrispondenti in PipelineEndpoint.

NOTA: questo metodo è deprecato a favore di list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parametri

Nome	Descrizione
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Provider del flusso di lavoro. Valore predefinito: None
_service_endpoint	str Endpoint del servizio. Valore predefinito: None

Restituisce

Tipo	Descrizione
list	Elenco di PipelineVersion oggetti.

get_default_version

Ottenere la versione predefinita di PipelineEndpoint.

get_default_version()

Restituisce

Tipo	Descrizione
str	Versione predefinita dell'endpoint della pipeline.

get_pipeline

Ottenere la pipeline di una versione specificata o dell'impostazione predefinita; genera un'eccezione se la versione non viene trovata.

get_pipeline(version=None)

Parametri

Nome	Descrizione
version	str Versione della pipeline da restituire. Valore predefinito: None

Restituisce

Tipo	Descrizione
PublishedPipeline	Una pipeline pubblicata.

list

Elencare pipelineEndpoint attivi nell'area di lavoro corrente.

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

Parametri

Nome	Descrizione
workspace Necessario	Workspace Area di lavoro.
active_only	bool Se true, restituisce solo PipelineEndpoints attualmente attivi. Valore predefinito: True
max_results	int max lines of returned PipelineEndpoints Valore predefinito: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Provider del flusso di lavoro. Valore predefinito: None
_service_endpoint	str Endpoint del servizio. Valore predefinito: None

Restituisce

Tipo	Descrizione
list	Elenco di PipelineEndpoint oggetti.

list_pipelines

Ottenere un elenco di pipeline associate a PipelineEndpoint.

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

Parametri

Nome	Descrizione
active_only	bool Indica se restituire solo pipeline attive. Valore predefinito: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Provider del flusso di lavoro. Valore predefinito: None
_service_endpoint	str Endpoint del servizio. Valore predefinito: None

Restituisce

Tipo	Descrizione
list	Elenco di PublishedPipeline oggetti.

list_versions

Ottenere un elenco di pipeline e versioni corrispondenti di PipelineEndpoint.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parametri

Nome	Descrizione
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Provider del flusso di lavoro. Valore predefinito: None
_service_endpoint	str Endpoint del servizio. Valore predefinito: None

Restituisce

Tipo	Descrizione
list	Elenco di PipelineVersion oggetti.

publish

Creare un oggetto PipelineEndpoint con il nome e la pipeline e la pipeline/pubblicata specificati.

L'endpoint della pipeline è un'API REST che può essere usata da applicazioni esterne. Per informazioni su come eseguire l'autenticazione quando si chiamano gli endpoint REST, vedere https://aka.ms/pl-restep-auth.

Per altre informazioni sull'uso degli endpoint della pipeline, vedere https://aka.ms/pl-first-pipeline.

Genera un'eccezione se esiste già un oggetto PipelineEndpoint con il nome specificato.

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

Parametri

Nome	Descrizione
workspace Necessario	Workspace Area di lavoro in cui creare PipelineEndpoint.
name Necessario	str Nome dell'oggetto PipelineEndpoint.
description Necessario	str Descrizione di PipelineEndpoint.
pipeline Necessario	PublishedPipeline oppure Pipeline Pipeline o pipeline pubblicate.
_service_endpoint	str Endpoint del servizio. Valore predefinito: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Provider del flusso di lavoro. Valore predefinito: None

Restituisce

Tipo	Descrizione
PipelineEndpoint	Nuovo oggetto PipelineEndpoint.

Eccezioni

Tipo	Descrizione
ValueError

reactivate

Riattivare un oggetto PipelineEndpoint archiviato.

reactivate(name)

Parametri

Nome	Descrizione
name Necessario	str Nome da impostare.

Restituisce

Tipo	Descrizione
PipelineEndpoint	Oggetto PipelineEndpoint.

set_default

Impostare la versione predefinita di PipelineEndpoint, genera un'eccezione se la pipeline specificata non viene trovata.

set_default(pipeline)

Parametri

Nome	Descrizione
pipeline Necessario	PublishedPipeline Pipeline pubblicata da impostare come predefinita.

Eccezioni

Tipo	Descrizione
ValueError

set_default_version

Impostare la versione predefinita di PipelineEndpoint, genera un'eccezione se la versione specificata non viene trovata.

set_default_version(version)

Parametri

Nome	Descrizione
version Necessario	str Versione da impostare come versione predefinita in PipelineEndpoint.

Eccezioni

Tipo	Descrizione
ValueError

set_name

Impostare il nome di PipelineEndpoint.

set_name(name)

Parametri

Nome	Descrizione
name Necessario	str Nome da impostare.

submit

Inviare un esperimento della pipeline di una determinata versione; se la versione è none attiva la versione predefinita della pipeline.

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

Parametri

Nome	Descrizione
experiment_name Necessario	str Nome dell'esperimento in cui inviare la pipeline.
pipeline_parameters	dict Parametri da usare nell'esecuzione della pipeline, passati come dizionario di {name: value}. Per altri dettagli, vedere PipelineParameter. Valore predefinito: None
parent_run_id	str È possibile specificare un ID esecuzione per impostare l'esecuzione padre di questa esecuzione della pipeline, che si riflette in RunHistory. L'esecuzione padre deve appartenere allo stesso esperimento a cui viene inviata la pipeline. Valore predefinito: None
pipeline_version	str Versione della pipeline da eseguire. Valore predefinito: None

Restituisce

Tipo	Descrizione
PipelineRun	Esecuzione della pipeline inviata.

Eccezioni

Tipo	Descrizione
ValueError

Attributi

default_version

Ottenere la versione predefinita di PipelineEndpoint.

Restituisce

Tipo	Descrizione
str	Versione predefinita.

description

Ottenere la descrizione di PipelineEndpoint.

Restituisce

Tipo	Descrizione
str	Descrizione.

endpoint

Ottenere l'URL dell'endpoint REST di PipelineEndpoint.

L'endpoint può essere usato per attivare le esecuzioni della pipeline.

Restituisce

Tipo	Descrizione
str	Endpoint REST per PipelineEndpoint per l'esecuzione della pipeline.

id

Ottenere l'ID di PipelineEndpoint.

Restituisce

Tipo	Descrizione
str	ID di PipelineEndpoint.

name

Ottenere il nome di PipelineEndpoint.

Restituisce

Tipo	Descrizione
str	Nome.

pipeline_version_list

Ottenere l'elenco delle versioni della pipeline.

Restituisce

Tipo	Descrizione
list	Elenco di PipelineIdVersion oggetti.

status

Ottenere lo stato di PipelineEndpoint.

Restituisce

Tipo	Descrizione
str	Stato.

swaggerurl

Ottenere l'URL Swagger REST di PipelineEndpoint.

L'URL di Swagger può essere visualizzato nello schema dell'endpoint della pipeline.

Restituisce

Tipo	Descrizione
str	REST Swagger per PipelineEndpoint per eseguire la pipeline.