Partager via

PipelineEndpoint Classe

Représente un Pipeline flux de travail qui peut être déclenché à partir d’une URL de point de terminaison unique.

PipelineEndpoints peut être utilisé pour créer de nouvelles versions d’un PublishedPipeline point de terminaison tout en conservant le même point de terminaison. Les pipelineEndpoints sont nommés de manière unique dans un espace de travail.

À l’aide de l’attribut de point de terminaison d’un objet PipelineEndpoint, vous pouvez déclencher de nouvelles exécutions de pipeline à partir d’applications externes avec des appels REST. Pour plus d’informations sur l’authentification lors de l’appel de points de terminaison REST, consultez https://aka.ms/pl-restep-auth.

Pour plus d’informations sur la création et l’exécution de pipelines Machine Learning, consultez https://aka.ms/pl-first-pipeline.

Initialiser PipelineEndpoint.

Constructeur

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

Paramètres

Nom Description
workspace
Obligatoire
Workspace

L’espace de travail dans lequel PipelineEndpoint est défini.
id
Obligatoire
str

ID du pipelineEndpoint.
name
Obligatoire
str

Nom du pipelineEndpoint.
description
Obligatoire
str

Description du pipelineEndpoint.
status
Obligatoire
str

Nouvel état du pipelineEndpoint : « Actif » ou « Désactivé ».
default_version
Obligatoire
str

La version par défaut du pipeline dans PipelineEndpoint, incréments automatiques, commence par « 0 ».
endpoint
Obligatoire
str

URL du point de terminaison REST du pipelineEndpoint, qui peut être utilisée pour envoyer des exécutions de pipeline.
pipeline_version_list
Obligatoire
list

Liste des PipelineIdVersion objets.
_pipeline_endpoint_provider
Obligatoire
<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>

Fournisseur PipelineEndpoint.
_pipeline_endpoint_provider
Obligatoire

Fournisseur PublishedPipeline.
workspace
Obligatoire
Workspace

L’objet d’espace de travail auquel appartient PipelineEndpoint.
id
Obligatoire
str

ID du pipelineEndpoint.
name
Obligatoire
str

Nom du pipelineEndpoint.
description
Obligatoire
str

Description du pipelineEndpoint.
status
Obligatoire
str

Nouvel état du pipelineEndpoint : « Actif » ou « Désactivé ».
default_version
Obligatoire
str

La version par défaut du pipeline dans PipelineEndpoint, incréments automatiques, commence par « 0 »
endpoint
Obligatoire
str

URL du point de terminaison REST de PipelineEndpoint pour envoyer des exécutions de pipeline.
pipeline_version_list
Obligatoire
list

Liste des PipelineIdVersion
_pipeline_endpoint_provider
Obligatoire
<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>

Fournisseur PipelineEndpoint.
_pipeline_endpoint_provider
Obligatoire

Fournisseur PublishedPipeline.
swaggerendpoint
Obligatoire

URL du point de terminaison REST Swagger pour PipelineEndpoint pour envoyer des exécutions de pipeline.

Remarques

Un pipelineEndpoint peut être créé à partir d’un Pipeline ou d’un PublishedPipeline.

Voici un exemple de publication à partir d’un pipeline ou de PublishPipeline :


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

Envoyer un pipelineEndpoint à l’aide submitde . Lorsque l’envoi est appelé, un PipelineRun objet est créé à son tour pour StepRun chaque étape du flux de travail.

Voici un exemple d’envoi d’un pipelineEndpoint :


   from azureml.pipeline.core import PipelineEndpoint

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

Il existe plusieurs paramètres facultatifs qui peuvent être spécifiés lors de l’envoi d’un pipelineEndpoint. Voici quelques-uns des éléments suivants :

  • pipeline_parameters : paramètres pour l’exécution du pipeline, dictionnaire de {name : value}. Pour plus d’informations, consultez l’article PipelineParameter.

  • parent_run_id : vous pouvez fournir un ID d’exécution pour définir l’exécution parente de cette exécution de pipeline, qui est reflétée dans RunHistory. L’exécution parente doit appartenir à la même expérience que celle à laquelle ce pipeline est soumis.

  • pipeline_version : version du pipeline à exécuter.

Un exemple pour envoyer un pipelineEndpoint à l’aide de ces paramètres est le suivant :


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

Pour ajouter une nouvelle version d’un pipelineEndpoint, utilisez :


   from azureml.pipeline.core import PipelineEndpoint

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

Pour plus d’informations sur la création et l’utilisation de PipelineEndpoints, consultez le bloc-notes suivant : https://aka.ms/pl-ver-endpoint.

Méthodes

add

Ajoutez le pipeline spécifié à PipelineEndpoint.
add_default

Ajoutez le pipeline spécifié à PipelineEndpoint et définissez la version par défaut pour ajouter la version du pipeline.
archive

Archivez pipelineEndpoint.
disable

Définissez PipelineEndpoint sur « Désactivé » et indisponible pour s’exécuter.
enable

Définissez PipelineEndpoint sur « Actif » et disponible pour l’exécution.
get

Obtient pipelineEndpoint par nom ou ID, lève une exception si l’un ou l’autre n’est pas fourni.
get_all

Obtenez tous les pipelineEndpoints actifs dans l’espace de travail actuel.

Obtenez tous les pipelineEndpoints actifs. REMARQUE : Cette méthode est déconseillée en faveur de PipelineEndpoint.list().
get_all_pipelines

Obtenir la liste des pipelines dans PipelineEndpoint.

REMARQUE : Cette méthode est déconseillée en faveur de list_pipelines()
get_all_versions

Obtenir la liste des pipelines et des versions correspondantes dans PipelineEndpoint.

REMARQUE : Cette méthode est déconseillée en faveur de list_versions()
get_default_version

Obtenez la version par défaut de PipelineEndpoint.
get_pipeline

Obtenir le pipeline d’une version spécifiée ou de la valeur par défaut ; lève une exception si la version est introuvable.
list

Répertorier les pipelineEndpoints actifs dans l’espace de travail actuel.
list_pipelines

Obtenez la liste des pipelines associés au pipelineEndpoint.
list_versions

Obtenez la liste des pipelines et des versions correspondantes du pipelineEndpoint.
publish

Créez un pipelineEndpoint avec le nom et le pipeline/pipeline publié spécifiés.

Le point de terminaison de pipeline est une API REST qui peut être utilisée à partir d’applications externes. Pour plus d’informations sur l’authentification lors de l’appel de points de terminaison REST, consultez https://aka.ms/pl-restep-auth.

Pour plus d’informations sur l’utilisation des points de terminaison de pipeline, consultez https://aka.ms/pl-first-pipeline.

Lève une exception si un pipelineEndpoint portant le nom donné existe déjà.
reactivate

Réactivez un pipelineEndpoint archivé.
set_default

Définissez la version par défaut de PipelineEndpoint, lève une exception si le pipeline spécifié est introuvable.
set_default_version

Définissez la version par défaut de PipelineEndpoint, lève une exception si la version spécifiée est introuvable.
set_name

Définissez le nom de PipelineEndpoint.
submit

Soumettre une expérience de pipeline de version donnée ; si la version n’est pas déclenche la version par défaut du pipeline.

add

Ajoutez le pipeline spécifié à PipelineEndpoint.

add(pipeline)

Paramètres

Nom Description
pipeline
Obligatoire
PublishedPipeline

Pipeline publié à ajouter.

add_default

Ajoutez le pipeline spécifié à PipelineEndpoint et définissez la version par défaut pour ajouter la version du pipeline.

add_default(pipeline)

Paramètres

Nom Description
pipeline
Obligatoire
PublishedPipeline

Pipeline publié à ajouter comme version par défaut.

archive

Archivez pipelineEndpoint.

archive()

disable

Définissez PipelineEndpoint sur « Désactivé » et indisponible pour s’exécuter.

disable()

enable

Définissez PipelineEndpoint sur « Actif » et disponible pour l’exécution.

enable()

get

Obtient pipelineEndpoint par nom ou ID, lève une exception si l’un ou l’autre n’est pas fourni.

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

Paramètres

Nom Description
workspace
Obligatoire
Workspace

L’espace de travail dans lequel PipelineEndpoint a été créé.
id
str

ID du pipelineEndpoint.

Valeur par défaut: None
name
str

Nom du pipelineEndpoint.

Valeur par défaut: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Fournisseur de flux de travail.

Valeur par défaut: None
_service_endpoint
str

Point de terminaison de service.

Valeur par défaut: None

Retours

Type Description
PipelineEndpoint

Objet PipelineEndpoint.

get_all

Obtenez tous les pipelineEndpoints actifs dans l’espace de travail actuel.

Obtenez tous les pipelineEndpoints actifs. REMARQUE : Cette méthode est déconseillée en faveur de PipelineEndpoint.list().

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

Paramètres

Nom Description
workspace
Obligatoire
Workspace

Espace de travail.
active_only
bool

Si la valeur est true, retournez uniquement les pipelineEndpoints qui sont actuellement actifs.

Valeur par défaut: True
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Fournisseur de flux de travail.

Valeur par défaut: None
_service_endpoint
str

Point de terminaison de service.

Valeur par défaut: None

Retours

Type Description
list

Liste des PipelineEndpoint objets.

get_all_pipelines

Obtenir la liste des pipelines dans PipelineEndpoint.

REMARQUE : Cette méthode est déconseillée en faveur de list_pipelines()

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

Paramètres

Nom Description
active_only
bool

Indicateur pour retourner des pipelines actifs uniquement.

Valeur par défaut: True
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Fournisseur de flux de travail.

Valeur par défaut: None
_service_endpoint
str

Point de terminaison de service.

Valeur par défaut: None

Retours

Type Description
list

Liste des PublishedPipeline objets.

get_all_versions

Obtenir la liste des pipelines et des versions correspondantes dans PipelineEndpoint.

REMARQUE : Cette méthode est déconseillée en faveur de list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Paramètres

Nom Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Fournisseur de flux de travail.

Valeur par défaut: None
_service_endpoint
str

Point de terminaison de service.

Valeur par défaut: None

Retours

Type Description
list

Liste des PipelineVersion objets.

get_default_version

Obtenez la version par défaut de PipelineEndpoint.

get_default_version()

Retours

Type Description
str

Version par défaut du point de terminaison de pipeline.

get_pipeline

Obtenir le pipeline d’une version spécifiée ou de la valeur par défaut ; lève une exception si la version est introuvable.

get_pipeline(version=None)

Paramètres

Nom Description
version
str

Version du pipeline à retourner.

Valeur par défaut: None

Retours

Type Description
PublishedPipeline

Pipeline publié.

list

Répertorier les pipelineEndpoints actifs dans l’espace de travail actuel.

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

Paramètres

Nom Description
workspace
Obligatoire
Workspace

Espace de travail.
active_only
bool

Si la valeur est true, retournez uniquement les pipelineEndpoints qui sont actuellement actifs.

Valeur par défaut: True
max_results
int

nombre maximal de lignes de pipelineEndpoints retournés

Valeur par défaut: 100
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Fournisseur de flux de travail.

Valeur par défaut: None
_service_endpoint
str

Point de terminaison de service.

Valeur par défaut: None

Retours

Type Description
list

Liste des PipelineEndpoint objets.

list_pipelines

Obtenez la liste des pipelines associés au pipelineEndpoint.

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

Paramètres

Nom Description
active_only
bool

Indique s’il faut retourner uniquement des pipelines actifs.

Valeur par défaut: True
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Fournisseur de flux de travail.

Valeur par défaut: None
_service_endpoint
str

Point de terminaison de service.

Valeur par défaut: None

Retours

Type Description
list

Liste des PublishedPipeline objets.

list_versions

Obtenez la liste des pipelines et des versions correspondantes du pipelineEndpoint.

list_versions(_workflow_provider=None, _service_endpoint=None)

Paramètres

Nom Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Fournisseur de flux de travail.

Valeur par défaut: None
_service_endpoint
str

Point de terminaison de service.

Valeur par défaut: None

Retours

Type Description
list

Liste des PipelineVersion objets.

publish

Créez un pipelineEndpoint avec le nom et le pipeline/pipeline publié spécifiés.

Le point de terminaison de pipeline est une API REST qui peut être utilisée à partir d’applications externes. Pour plus d’informations sur l’authentification lors de l’appel de points de terminaison REST, consultez https://aka.ms/pl-restep-auth.

Pour plus d’informations sur l’utilisation des points de terminaison de pipeline, consultez https://aka.ms/pl-first-pipeline.

Lève une exception si un pipelineEndpoint portant le nom donné existe déjà.

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

Paramètres

Nom Description
workspace
Obligatoire
Workspace

Espace de travail dans lequel créer PipelineEndpoint.
name
Obligatoire
str

Nom du pipelineEndpoint.
description
Obligatoire
str

Description du pipelineEndpoint.
pipeline
Obligatoire
PublishedPipeline ou Pipeline

Pipeline ou pipeline publié.
_service_endpoint
str

Point de terminaison de service.

Valeur par défaut: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Fournisseur de flux de travail.

Valeur par défaut: None

Retours

Type Description
PipelineEndpoint

Nouveau PipelineEndpoint.

Exceptions

Type Description
ValueError

reactivate

Réactivez un pipelineEndpoint archivé.

reactivate(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom à définir.

Retours

Type Description
PipelineEndpoint

Objet PipelineEndpoint.

set_default

Définissez la version par défaut de PipelineEndpoint, lève une exception si le pipeline spécifié est introuvable.

set_default(pipeline)

Paramètres

Nom Description
pipeline
Obligatoire
PublishedPipeline

Pipeline publié à définir comme valeur par défaut.

Exceptions

Type Description
ValueError

set_default_version

Définissez la version par défaut de PipelineEndpoint, lève une exception si la version spécifiée est introuvable.

set_default_version(version)

Paramètres

Nom Description
version
Obligatoire
str

Version à définir comme version par défaut dans PipelineEndpoint.

Exceptions

Type Description
ValueError

set_name

Définissez le nom de PipelineEndpoint.

set_name(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom à définir.

submit

Soumettre une expérience de pipeline de version donnée ; si la version n’est pas déclenche la version par défaut du pipeline.

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

Paramètres

Nom Description
experiment_name
Obligatoire
str

Nom de l’expérience dans laquelle envoyer le pipeline.
pipeline_parameters
dict

Paramètres à utiliser dans l’exécution du pipeline, transmis en tant que dictionnaire de {name : value}. Pour plus d’informations, consultez l’article PipelineParameter.

Valeur par défaut: None
parent_run_id
str

Vous pouvez fournir un ID d’exécution pour définir l’exécution parente de cette exécution de pipeline, qui est reflétée dans RunHistory. L’exécution parente doit appartenir à la même expérience que celle à laquelle ce pipeline est soumis.

Valeur par défaut: None
pipeline_version
str

Version du pipeline à exécuter.

Valeur par défaut: None

Retours

Type Description
PipelineRun

Exécution du pipeline envoyé.

Exceptions

Type Description
ValueError

Attributs

default_version

Obtenez la version par défaut du pipelineEndpoint.

Retours

Type Description
str

Version par défaut.

description

Obtenez la description du pipelineEndpoint.

Retours

Type Description
str

Description.

endpoint

Obtenez l’URL du point de terminaison REST du pipelineEndpoint.

Le point de terminaison peut être utilisé pour déclencher des exécutions du pipeline.

Retours

Type Description
str

Point de terminaison REST pour PipelineEndpoint pour exécuter le pipeline.

id

Obtenez l’ID du pipelineEndpoint.

Retours

Type Description
str

ID du pipelineEndpoint.

name

Obtenez le nom du pipelineEndpoint.

Retours

Type Description
str

Nom.

pipeline_version_list

Obtenez la liste des versions du pipeline.

Retours

Type Description
list

Liste des PipelineIdVersion objets.

status

Obtenez l’état du pipelineEndpoint.

Retours

Type Description
str

État.

swaggerurl

Obtenez l’URL REST Swagger du pipelineEndpoint.

L’URL Swagger peut être afficher le schéma du point de terminaison du pipeline.

Retours

Type Description
str

REST Swagger pour PipelineEndpoint pour exécuter le pipeline.