PublishedPipeline Classe

Référence

Représente un pipeline à envoyer sans le code Python qui l’a construit.

En outre, un PublishedPipeline peut être utilisé pour renvoyer un Pipeline avec différentes valeurs et entrées PipelineParameter.

Initialisez PublishedPipeline.

:p point de terminaisonaram L’URL du point de terminaison REST pour envoyer le pipeline s’exécute pour ce pipeline. :type endpoint: str :p aram total_run_steps : nombre d’étapes dans ce pipeline :type total_run_steps: int :p aram workspace: Espace de travail du pipeline publié. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure : Continuer l’exécution d’autres étapes dans pipelineRun

si une étape échoue, la valeur par défaut est false.

Héritage: azureml.core._portal.HasPipelinePortal

PublishedPipeline

Constructeur

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

Paramètres

Nom	Description
name Obligatoire	str Nom du pipeline publié.
graph_id Obligatoire	str ID du graphe pour ce pipeline publié.
description Obligatoire	str Description du pipeline publié.
version Obligatoire	str Version du pipeline publié.
published_pipeline_id Obligatoire	str ID du pipeline publié.
status Obligatoire	str État du pipeline publié (« Actif » ou « Désactivé »).
endpoint Obligatoire	str URL du point de terminaison REST pour envoyer des exécutions pour ce pipeline.
total_run_steps Obligatoire	int Nombre d’étapes dans ce pipeline.
workspace Obligatoire	Workspace Espace de travail du pipeline publié.
continue_on_step_failure Obligatoire	bool Indique si l’exécution des autres étapes dans le PipelineRun doit continuer en cas d’échec d’une étape. La valeur par défaut est false.
_pipeline_provider Obligatoire	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> Fournisseur du pipeline publié.
kwargs Obligatoire	dict Arguments de mot clé personnalisés, réservés à des fins de développement futur
name Obligatoire	str Nom du pipeline publié.
graph_id Obligatoire	str ID du graphe pour ce pipeline publié.
description Obligatoire	str Description du pipeline publié.
version Obligatoire	str Version du pipeline publié.
published_pipeline_id Obligatoire	str ID du pipeline publié.
status Obligatoire	str État du pipeline publié (« Actif » ou « Désactivé »).
_pipeline_provider Obligatoire	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> Fournisseur du pipeline publié.
kwargs Obligatoire	dict Arguments de mot clé personnalisés, réservés à des fins de développement futur

Remarques

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

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


   from azureml.pipeline.core import Pipeline

   pipeline = Pipeline(workspace=ws, steps=steps)
   published_pipeline = pipeline.publish(name="My_New_Pipeline",
                                         description="My New Pipeline Description",
                                         version="1.0",
                                         continue_on_step_failure=True)

Pour publier à partir d’un PipelineRun, utilisez :


   from azureml.pipeline.core import PipelineRun

   pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
   published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
                                                      description="My New Pipeline Description",
                                                      version="1.0",
                                                      continue_on_step_failure=True)

Remarque : Le paramètre continue_on_step_failure spécifie si l’exécution des étapes dans le pipeline se poursuit en cas d’échec d’une étape. La valeur par défaut est False, ce qui signifie qu’en cas d’échec d’une étape, l’exécution du pipeline s’arrête, annulant toutes les étapes en cours d’exécution.

Envoyez un PublishedPipeline à 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 PublishedPipeline :


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

Il existe plusieurs paramètres facultatifs pouvant être spécifiés lors de l’envoi d’un PublishedPipeline. Il s’agit notamment des paramètres suivants :

continue_on_step_failure : indique si l’exécution des autres étapes du PipelineRun doit continuer en cas d’échec d’une étape (facultatif). Seules les étapes qui n’ont aucune dépendance vis-à-vis de la sortie de l’étape qui a échoué continuent à s’exécuter. S’il est défini, ce paramètre remplace le paramètre sur le pipeline.
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 le pipeline est soumis.

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


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline,
                                    continue_on_step_failure=True,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>")

Tous les pipelines publiés disposent d’un point de terminaison REST. Avec le point de terminaison de pipeline, vous pouvez déclencher une exécution du pipeline à partir de systèmes externes, comme des clients autres que Python. 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.

L’utilisation de ce point de terminaison active par exemple la « répétabilité managée » dans les scénarios de scoring et de recyclage. Pour plus d’informations, consultez https://aka.ms/pl-first-pipeline.

Méthodes

disable	Définissez le pipeline publié sur « Désactivé » et non disponible pour l’exécution.
enable	Définissez le pipeline publié sur « Actif » et disponible pour l’exécution.
get	Obtenez le pipeline publié.
get_all	Obtenez tous les pipelines publiés dans l’espace de travail actuel. DÉPRÉCIÉE : Cette méthode est dépréciée en faveur de la méthode list PublishedPipeline.
get_graph	Obtenez le graphe du PublishedPipeline.
get_step_names	Obtenez la liste des noms des étapes dans le PublishedPipeline.
list	Obtenez tous les pipelines publiés dans l’espace de travail actuel.
save	Enregistrez le code YAML du pipeline dans un fichier. Actuellement, seuls les pipelines constitués de ModuleSteps sont pris en charge pour l’exportation YAML.
submit	Soumettez le pipeline publié. Cela équivaut à utiliser submit. Retourne le PipelineRun soumis. Utiliser cet objet pour superviser et afficher les détails de l’exécution.

disable

Définissez le pipeline publié sur « Désactivé » et non disponible pour l’exécution.

disable()

enable

Définissez le pipeline publié sur « Actif » et disponible pour l’exécution.

enable()

get

Obtenez le pipeline publié.

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

Paramètres

Nom	Description
workspace Obligatoire	Workspace Espace de travail dans lequel le pipeline publié a été créé.
id Obligatoire	str ID du pipeline publié.
_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
PublishedPipeline	Objet PublishedPipeline.

get_all

Obtenez tous les pipelines publiés dans l’espace de travail actuel.

DÉPRÉCIÉE : Cette méthode est dépréciée en faveur de la méthode list PublishedPipeline.

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

Paramètres

Nom	Description
workspace Obligatoire	Workspace Espace de travail sur lequel le pipeline publié a été créé.
active_only	bool Indique de retourner uniquement ou non les pipelines publiés actuellement actifs. valeur par défaut: True
_service_endpoint	str Point de terminaison du service. valeur par défaut: None

Retours

Type	Description
list[PublishedPipeline]	Liste des objets PublishedPipeline.

get_graph

Obtenez le graphe du PublishedPipeline.

get_graph(_workflow_provider=None)

Paramètres

Nom	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Fournisseur de workflow. valeur par défaut: None

Retours

Type	Description
Graph	Graphique.

get_step_names

Obtenez la liste des noms des étapes dans le PublishedPipeline.

get_step_names(_workflow_provider=None)

Paramètres

Nom	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Fournisseur de workflow. valeur par défaut: None

Retours

Type	Description
List[str]	Liste des noms des étapes dans le PublishedPipeline.

list

Obtenez tous les pipelines publiés dans l’espace de travail actuel.

static list(workspace, active_only=True, _service_endpoint=None)

Paramètres

Nom	Description
workspace Obligatoire	Workspace Espace de travail dans lequel le pipeline publié a été créé.
active_only	bool Indique de retourner uniquement ou non les pipelines publiés actuellement actifs. valeur par défaut: True
_service_endpoint	str Point de terminaison du service. valeur par défaut: None

Retours

Type	Description
list[PublishedPipeline]	Liste des objets PublishedPipeline.

save

Enregistrez le code YAML du pipeline dans un fichier.

Actuellement, seuls les pipelines constitués de ModuleSteps sont pris en charge pour l’exportation YAML.

save(path=None, _workflow_provider=None)

Paramètres

Nom	Description
path	str Chemin d’enregistrement du fichier YAML. Si le chemin est un répertoire, le fichier YAML de pipeline est enregistré dans path/pipeline_name.yml. Si le chemin est défini sur None, le répertoire actuel est utilisé. 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
None

submit

Soumettez le pipeline publié. Cela équivaut à utiliser submit.

Retourne le PipelineRun soumis. Utiliser cet objet pour superviser et afficher les détails de l’exécution.

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

Paramètres

Nom	Description
workspace Obligatoire	Workspace Espace de travail sur lequel envoyer le pipeline publié.
experiment_name Obligatoire	str Nom de l’expérience auquel l’envoyer.
pipeline_parameters	dict Dictionnaire de paramètres pour affecter de nouvelles valeurs {nom du paramètre, valeur du paramètre}. Consultez PipelineParameter pour plus d’informations. 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
parent_run_id	str ID d’exécution facultatif à définir pour l’exécution parent de cette exécution de pipeline, qui est reflété 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
continue_on_step_failure	bool Indique si l’exécution des autres étapes du PipelineRun doit continuer ou non en cas d’échec d’une étape (facultatif). S’il est défini, ce paramètre remplace le paramètre du pipeline. valeur par défaut: None

Retours

Type	Description
PipelineRun	Exécution du pipeline envoyée.

Attributs

continue_on_step_failure

Permet d’obtenir la valeur du paramètre continue_on_step_failure.

Retours

Type	Description
bool	Valeur du paramètre `continue_on_step_failure`.

description

Obtenez la description du pipeline publié.

Retours

Type	Description
str	Description du pipeline publié.

endpoint

Obtenez l’URL du point de terminaison REST pour l’exécution d’un pipeline publié.

Retours

Type	Description
str	URL du point de terminaison REST pour l’exécution du pipeline publié.

graph_id

Obtenez l’ID du graphe pour ce pipeline publié.

Retours

Type	Description
str	ID du graphe.

id

Obtenez l’ID du pipeline publié.

Retours

Type	Description
str	ID du pipeline publié.

name

Obtenez le nom du pipeline publié.

Retours

Type	Description
str	Nom du pipeline publié.

status

Obtenez l’état du pipeline publié.

Retours

Type	Description
str	État du pipeline publié.

total_run_steps

Obtenez le nombre d’étapes dans le pipeline.

Retours

Type	Description
int	Nombre d’étapes dans le pipeline.

version

Obtenez la version du pipeline publié.

Retours

Type	Description
str	Version du pipeline publié.

Partager via

PublishedPipeline Classe

Constructeur

Paramètres

Remarques

Méthodes

disable

enable

get

Paramètres

Retours

get_all

Paramètres

Retours

get_graph

Paramètres

Retours

get_step_names

Paramètres

Retours

list

Paramètres

Retours

save

Paramètres

Retours

submit

Paramètres

Retours

Attributs

continue_on_step_failure

Retours

description

Retours

endpoint

Retours

graph_id

Retours

id

Retours

name

Retours

status

Retours

total_run_steps

Retours

version

Retours

Commentaires

Commentaires

Ressources supplémentaires