PipelineEndpoint Classe
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.objectPipelineEndpoint
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
- default_version
- str
La version par défaut du pipeline dans PipelineEndpoint, auto-incrémentation, commence par « 0 ».
- endpoint
- str
URL du point de terminaison REST pour PipelineEndpoint, qui peut être utilisée pour envoyer des exécutions de pipeline.
- _pipeline_endpoint_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>
Fournisseur du PipelineEndpoint.
- _pipeline_endpoint_provider
Fournisseur du PublishedPipeline.
- default_version
- str
La version par défaut du pipeline dans PipelineEndpoint, incréments automatiques, commence par « 0 »
- endpoint
- str
URL du point de terminaison REST pour PipelineEndpoint pour envoyer des exécutions de pipeline.
- _pipeline_endpoint_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>
Fournisseur du PipelineEndpoint.
- _pipeline_endpoint_provider
Fournisseur du PublishedPipeline.
- swaggerendpoint
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
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
archive
Archive le PipelineEndpoint.
archive()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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Fournisseur de workflow.
Retours
Objet PipelineEndpoint.
Type de retour
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
- active_only
- bool
Si True est défini, retourne uniquement les PipelineEndpoints qui sont actuellement actifs.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Fournisseur de workflow.
Retours
Liste des objets PipelineEndpoint.
Type de retour
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Fournisseur de workflow.
Retours
Liste des objets PublishedPipeline.
Type de retour
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Fournisseur de workflow.
Retours
Liste des objets PipelineVersion.
Type de retour
get_default_version
Obtient la version par défaut du PipelineEndpoint.
get_default_version()Retours
Version par défaut du point de terminaison du pipeline.
Type de retour
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
Retours
Pipeline publié.
Type de retour
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
- active_only
- bool
Si True est défini, retourne uniquement les PipelineEndpoints qui sont actuellement actifs.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Fournisseur de workflow.
Retours
Liste des objets PipelineEndpoint.
Type de retour
list_pipelines
Obtient une liste des pipelines associés au PipelineEndpoint.
list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)Paramètres
- active_only
- bool
Indique si uniquement les pipelines actifs doivent être retournés.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Fournisseur de workflow.
Retours
Liste des objets PublishedPipeline.
Type de retour
list_versions
Obtient une liste des pipelines et les versions correspondantes du PipelineEndpoint.
list_versions(_workflow_provider=None, _service_endpoint=None)Paramètres
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Fournisseur de workflow.
Retours
Liste des objets PipelineVersion.
Type de retour
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Fournisseur de workflow.
Retours
Nouveau PipelineEndpoint.
Type de retour
Exceptions
reactivate
Réactive un PipelineEndpoint qui était archivé.
reactivate(name)Paramètres
Retours
Objet PipelineEndpoint.
Type de retour
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
Exceptions
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
Exceptions
set_name
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
- 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.
- 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.
Retours
Exécution du pipeline envoyée.
Type de retour
Exceptions
Attributs
default_version
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
Point de terminaison REST pour PipelineEndpoint pour exécuter le pipeline.
Type de retour
id
name
pipeline_version_list
Obtient la liste des versions du pipeline.
Retours
Liste des objets PipelineIdVersion.
Type de retour
status
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
REST Swagger pour PipelineEndpoint pour exécuter le pipeline.
Type de retour
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour