PipelineEndpoint Classe

Référence

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

Les objets PipelineEndpoint peuvent être utilisés pour créer de nouvelles versions d’un PublishedPipeline tout en conservant le même point de terminaison. Les objets PipelineEndpoint ont un nom 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 la procédure d’authentification lors de l’appel des 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 de Machine Learning, consultez https://aka.ms/pl-first-pipeline.

Initialiser PipelineEndpoint.

Héritage: builtins.object

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 Espace de travail dans lequel le PipelineEndpoint est défini.
id Obligatoire	str ID du PipelineEndpoint.
name Obligatoire	str Nom de l’ID 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, auto-incrémentation, commence par « 0 ».
endpoint Obligatoire	str URL du point de terminaison REST pour PipelineEndpoint, qui peut être utilisée pour envoyer des exécutions de pipeline.
pipeline_version_list Obligatoire	list Liste des objets PipelineIdVersion.
_pipeline_endpoint_provider Obligatoire	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Fournisseur du PipelineEndpoint.
_pipeline_endpoint_provider Obligatoire	Fournisseur du PublishedPipeline.
workspace Obligatoire	Workspace Objet d’espace de travail auquel appartiendra PipelineEndpoint.
id Obligatoire	str ID du PipelineEndpoint.
name Obligatoire	str Nom de l’ID 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 pour PipelineEndpoint pour envoyer des exécutions de pipeline.
pipeline_version_list Obligatoire	list Liste de PipelineIdVersion
_pipeline_endpoint_provider Obligatoire	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Fournisseur du PipelineEndpoint.
_pipeline_endpoint_provider Obligatoire	Fournisseur du 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 d’un PublishedPipeline :


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

Envoie un PipelineEndpoint à l’aide de submit. Lorsque l’envoi est appelé, un PipelineRun est créé, qui crée à son tour des objets StepRun pour 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)

Un certain nombre de paramètres facultatifs peuvent être spécifiés lors de l’envoi d’un PipelineEndpoint. Il s’agit notamment des paramètres suivants :

pipeline_parameters : paramètres d’exécution du pipeline, dictionnaire de {name: value}. Consultez PipelineParameter pour plus d’informations.
parent_run_id : vous pouvez fournir un ID d’exécution pour définir l’exécution parent de cette exécution de pipeline, qui est reflétée dans RunHistory. L’exécution parent doit appartenir à la même expérience que celle à laquelle ce pipeline est envoyé.
pipeline_version : version du pipeline à exécuter.

Voici un exemple d’envoi d’un PipelineEndpoint à l’aide de ces paramètres :


   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 des PipelineEndpoints, consultez le notebook suivant : https://aka.ms/pl-ver-endpoint.

Méthodes

add	Ajoute le pipeline spécifié à PipelineEndpoint.
add_default	Ajoute le pipeline spécifié à PipelineEndpoint et définit la version par défaut sur la version de pipeline ajoutée.
archive	Archive le PipelineEndpoint.
disable	Définit PipelineEndpoint sur « Désactivé » et indisponible pour l’exécution.
enable	Définit PipelineEndpoint sur « Actif » et disponible pour l’exécution.
get	Obtient le PipelineEndpoint par nom ou ID, lève une exception si aucun des deux n’est fourni.
get_all	Obtient tous les PipelineEndpoints actifs dans l’espace de travail actuel. Obtient tous les PipelineEndpoints actifs. REMARQUE : cette méthode est déconseillée au profit de PipelineEndpoint.list().
get_all_pipelines	Obtient une liste des pipelines dans PipelineEndpoint. REMARQUE : cette méthode est déconseillée au profit de list_pipelines()
get_all_versions	Obtient une liste des pipelines et les versions correspondantes du PipelineEndpoint. REMARQUE : cette méthode est déconseillée au profit de list_versions()
get_default_version	Obtient la version par défaut du PipelineEndpoint.
get_pipeline	Obtient le pipeline d’une version spécifiée ou la valeur par défaut ; lève une exception si la version est introuvable.
list	Répertorie les PipelineEndpoints actifs dans l’espace de travail actuel.
list_pipelines	Obtient une liste des pipelines associés au PipelineEndpoint.
list_versions	Obtient une liste des pipelines et les versions correspondantes du PipelineEndpoint.
publish	Crée un PipelineEndpoint avec le nom spécifié et le pipeline/pipeline publié. Le point de terminaison de pipeline est une API REST qui peut être utilisée à partir d’applications externes. Pour plus d’informations sur la procédure d’authentification lors de l’appel des 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 avec le nom spécifié existe déjà.
reactivate	Réactive un PipelineEndpoint qui était archivé.
set_default	Définit la version par défaut du PipelineEndpoint, lève une exception si le pipeline spécifié est introuvable.
set_default_version	Définit la version par défaut du PipelineEndpoint, lève une exception si la version spécifiée est introuvable.
set_name	Définit le nom du PipelineEndpoint.
submit	Envoie une expérience de pipeline de version donnée. Si la version est None, la version par défaut du pipeline est déclenchée.

add

Ajoute le pipeline spécifié à PipelineEndpoint.

add(pipeline)

Paramètres

Nom	Description
pipeline Obligatoire	PublishedPipeline Pipeline publié à ajouter.

add_default

Ajoute le pipeline spécifié à PipelineEndpoint et définit la version par défaut sur la version de pipeline ajoutée.

add_default(pipeline)

Paramètres

Nom	Description
pipeline Obligatoire	PublishedPipeline Pipeline publié à ajouter comme version par défaut.

disable

Définit PipelineEndpoint sur « Désactivé » et indisponible pour l’exécution.

disable()

enable

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

enable()

get

Obtient le PipelineEndpoint par nom ou ID, lève une exception si aucun des deux n’est fourni.

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

Paramètres

Nom	Description
workspace Obligatoire	Workspace Espace de travail dans lequel le PipelineEndpoint a été créé.
id	str ID du PipelineEndpoint. valeur par défaut: None
name	str Nom de l’ID du PipelineEndpoint. valeur par défaut: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Fournisseur de workflow. valeur par défaut: None
_service_endpoint	str Point de terminaison du service. valeur par défaut: None

Retours

Type	Description
PipelineEndpoint	Objet PipelineEndpoint.

get_all

Obtient tous les PipelineEndpoints actifs dans l’espace de travail actuel.

Obtient tous les PipelineEndpoints actifs. REMARQUE : cette méthode est déconseillée au profit 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 True est défini, retourne uniquement les PipelineEndpoints qui sont actuellement actifs. valeur par défaut: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Fournisseur de workflow. valeur par défaut: None
_service_endpoint	str Point de terminaison du service. valeur par défaut: None

Retours

Type	Description
list	Liste des objets PipelineEndpoint.

get_all_pipelines

Obtient une liste des pipelines dans PipelineEndpoint.

REMARQUE : cette méthode est déconseillée au profit 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 les pipelines actifs uniquement. valeur par défaut: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Fournisseur de workflow. valeur par défaut: None
_service_endpoint	str Point de terminaison du service. valeur par défaut: None

Retours

Type	Description
list	Liste des objets PublishedPipeline.

get_all_versions

Obtient une liste des pipelines et les versions correspondantes du PipelineEndpoint.

REMARQUE : cette méthode est déconseillée au profit 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 workflow. valeur par défaut: None
_service_endpoint	str Point de terminaison du service. valeur par défaut: None

Retours

Type	Description
list	Liste des objets PipelineVersion.

get_default_version

Obtient la version par défaut du PipelineEndpoint.

get_default_version()

Retours

Type	Description
str	Version par défaut du point de terminaison du pipeline.

get_pipeline

Obtient le pipeline d’une version spécifiée ou 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épertorie 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 True est défini, retourne uniquement les PipelineEndpoints qui sont actuellement actifs. valeur par défaut: True
max_results	int max lines of PipelineEndpoints retournés valeur par défaut: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Fournisseur de workflow. valeur par défaut: None
_service_endpoint	str Point de terminaison du service. valeur par défaut: None

Retours

Type	Description
list	Liste des objets PipelineEndpoint.

list_pipelines

Obtient une 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 si uniquement les pipelines actifs doivent être retournés. valeur par défaut: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Fournisseur de workflow. valeur par défaut: None
_service_endpoint	str Point de terminaison du service. valeur par défaut: None

Retours

Type	Description
list	Liste des objets PublishedPipeline.

list_versions

Obtient une liste des pipelines et les 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 workflow. valeur par défaut: None
_service_endpoint	str Point de terminaison du service. valeur par défaut: None

Retours

Type	Description
list	Liste des objets PipelineVersion.

publish

Crée un PipelineEndpoint avec le nom spécifié et le pipeline/pipeline publié.

Le point de terminaison de pipeline est une API REST qui peut être utilisée à partir d’applications externes. Pour plus d’informations sur la procédure d’authentification lors de l’appel des 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 avec le nom spécifié 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 le PipelineEndpoint.
name Obligatoire	str Nom de l’ID du PipelineEndpoint.
description Obligatoire	str Description du PipelineEndpoint.
pipeline Obligatoire	PublishedPipeline ou Pipeline Pipeline ou pipeline publié.
_service_endpoint	str Point de terminaison du service. valeur par défaut: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Fournisseur de workflow. valeur par défaut: None

Retours

Type	Description
PipelineEndpoint	Nouveau PipelineEndpoint.

Exceptions

Type	Description
ValueError

reactivate

Réactive un PipelineEndpoint qui était archivé.

reactivate(name)

Paramètres

Nom	Description
name Obligatoire	str Nom à définir.

Retours

Type	Description
PipelineEndpoint	Objet PipelineEndpoint.

set_default

Définit la version par défaut du 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éfinit la version par défaut du 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éfinit le nom du PipelineEndpoint.

set_name(name)

Paramètres

Nom	Description
name Obligatoire	str Nom à définir.

submit

Envoie une expérience de pipeline de version donnée. Si la version est None, la version par défaut du pipeline est déclenchée.

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 sur laquelle envoyer le pipeline.
pipeline_parameters	dict Paramètres à utiliser dans l’exécution du pipeline, transmis en tant que dictionnaire de {name: value}. Consultez PipelineParameter pour plus d’informations. valeur par défaut: None
parent_run_id	str Vous pouvez fournir un ID d’exécution pour définir l’exécution parent 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ée.

Exceptions

Type	Description
ValueError

Attributs

default_version

Obtient la version par défaut du PipelineEndpoint.

Retours

Type	Description
str	Version par défaut.

description

Obtient la description du PipelineEndpoint.

Retours

Type	Description
str	Description.

endpoint

Obtient 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

Obtient l’ID du PipelineEndpoint.

Retours

Type	Description
str	ID du PipelineEndpoint.

name

Obtient le nom du PipelineEndpoint.

Retours

Type	Description
str	Nom.

pipeline_version_list

Obtient la liste des versions du pipeline.

Retours

Type	Description
list	Liste des objets PipelineIdVersion.

status

Obtient l’état du PipelineEndpoint.

Retours

Type	Description
str	Statut.

swaggerurl

Obtient l’URL REST Swagger du PipelineEndpoint.

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

Retours

Type	Description
str	REST Swagger pour PipelineEndpoint pour exécuter le pipeline.

Share via

PipelineEndpoint Classe

Constructeur

Paramètres

Remarques

Méthodes

add

Paramètres

add_default

Paramètres

archive

disable

enable

get

Paramètres

Retours

get_all

Paramètres

Retours

get_all_pipelines

Paramètres

Retours

get_all_versions

Paramètres

Retours

get_default_version

Retours

get_pipeline

Paramètres

Retours

list

Paramètres

Retours

list_pipelines

Paramètres

Retours

list_versions

Paramètres

Retours

publish

Paramètres

Retours

Exceptions

reactivate

Paramètres

Retours

set_default

Paramètres

Exceptions

set_default_version

Paramètres

Exceptions

set_name

Paramètres

submit

Paramètres

Retours

Exceptions

Attributs

default_version

Retours

description

Retours

endpoint

Retours

id

Retours

name

Retours

pipeline_version_list

Retours

status

Retours

swaggerurl

Retours

Commentaires

Commentaires

Ressources supplémentaires