PublishedPipeline Classe

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

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

Initialiser PublishedPipeline.

:p aram endpoint L’URL du point de terminaison REST pour envoyer des exécutions de pipeline pour ce pipeline. :type point de terminaison : str :p aram total_run_steps : nombre d’étapes dans ce pipeline :type total_run_steps : espace de travail int :p aram : espace de travail de l’espace de travail publié. :type d’espace de travail : 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.

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 graphique pour ce pipeline publié.
description Obligatoire	str Description du pipeline publié.
version Obligatoire	str Version du pipeline publiée.
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 à 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 s’il faut poursuivre l’exécution d’autres étapes dans PipelineRun 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 de pipelines publié.
kwargs Obligatoire	dict Arguments de mot clé personnalisés, réservés au développement futur
name Obligatoire	str Nom du pipeline publié.
graph_id Obligatoire	str ID du graphique pour ce pipeline publié.
description Obligatoire	str Description du pipeline publié.
version Obligatoire	str Version du pipeline publiée.
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 de pipelines publié.
kwargs Obligatoire	dict Arguments de mot clé personnalisés, réservés au 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 continue si une étape échoue. La valeur par défaut est False, ce qui signifie qu’une étape échoue, l’exécution du pipeline s’arrête, annulant les étapes en cours d’exécution.

Envoyez un PublishedPipeline à 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 de soumission 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 un certain nombre de paramètres facultatifs qui peuvent être spécifiés lors de l’envoi d’une commande PublishedPipeline. Voici quelques-uns des éléments suivants :

continue_on_step_failure : indique s’il faut continuer l’exécution d’autres étapes dans PipelineRun en cas d’échec d’une étape, facultative. Seules les étapes qui n’ont aucune dépendance sur la sortie de l’étape ayant échoué continueront d’être exécutées. Si ce paramètre est fourni, ce paramètre remplace le paramètre sur le pipeline.
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 le pipeline en cours d’envoi.

Voici un exemple de soumission 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, tels que des clients non Python. Pour plus d’informations sur l’authentification lors de l’appel de points de terminaison REST, consultez https://aka.ms/pl-restep-auth.

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

Méthodes

disable	Définissez le pipeline publié sur « Désactivé » et indisponible à exécuter.
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ÉCONSEILLÉE : cette méthode est déconseillée en faveur de la méthode PublishedPipeline list .
get_graph	Obtenez le graphique de PublishedPipeline.
get_step_names	Obtenez la liste des noms d’étapes dans PublishedPipeline.
list	Obtenez tous les pipelines publiés dans l’espace de travail actuel.
save	Enregistrez le YAML de pipeline dans un fichier. Actuellement, seuls les pipelines constitués de ModuleSteps sont pris en charge pour l’exportation YAML.
submit	Envoyez le pipeline publié. Cela équivaut à utiliser submit. Retourne le fichier envoyé PipelineRun. Utilisez cet objet pour surveiller et afficher les détails de l’exécution.

disable

Définissez le pipeline publié sur « Désactivé » et indisponible à exécuter.

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 L’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 flux de travail. Valeur par défaut: None
_service_endpoint	str Point de terminaison de 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ÉCONSEILLÉE : cette méthode est déconseillée en faveur de la méthode PublishedPipeline list .

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

Paramètres

Nom	Description
workspace Obligatoire	Workspace L’espace de travail sur lequel le pipeline publié a été créé.
active_only	bool Indique s’il faut retourner uniquement les pipelines publiés actuellement actifs. Valeur par défaut: True
_service_endpoint	str Point de terminaison de service. Valeur par défaut: None

Retours

Type	Description
list[PublishedPipeline]	Liste des objets PublishedPipeline.

get_graph

Obtenez le graphique de PublishedPipeline.

get_graph(_workflow_provider=None)

Paramètres

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

Retours

Type	Description
Graph	Graphique.

get_step_names

Obtenez la liste des noms d’étapes dans PublishedPipeline.

get_step_names(_workflow_provider=None)

Paramètres

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

Retours

Type	Description
List[str]	Liste des noms des étapes dans 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 L’espace de travail dans lequel le pipeline publié a été créé.
active_only	bool Indique s’il faut retourner uniquement les pipelines publiés actuellement actifs. Valeur par défaut: True
_service_endpoint	str Point de terminaison de service. Valeur par défaut: None

Retours

Type	Description
list[PublishedPipeline]	Liste des objets PublishedPipeline.

save

Enregistrez le YAML de 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’accès dans lequel enregistrer le YAML. Si le chemin d’accès est un répertoire, le fichier YAML de pipeline est enregistré au niveau du chemin/pipeline_name.yml. Si le chemin d’accès est None, le répertoire actif est utilisé. 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
None

submit

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

Retourne le fichier envoyé PipelineRun. Utilisez cet objet pour surveiller 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 à soumettre.
pipeline_parameters	dict Dictionnaire de paramètres pour affecter de nouvelles valeurs {nom param, valeur param}. Pour plus d’informations, consultez l’article PipelineParameter. 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
parent_run_id	str ID d’exécution facultatif à définir pour 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 ce pipeline est soumis. Valeur par défaut: None
continue_on_step_failure	bool Indique s’il faut poursuivre l’exécution d’autres étapes dans PipelineRun en cas d’échec d’une étape, facultative. S’il est fourni, remplace le paramètre sur le pipeline. Valeur par défaut: None

Retours

Type	Description
PipelineRun	Exécution du pipeline envoyé.

Attributs

continue_on_step_failure

Obtenez la valeur du continue_on_step_failure paramètre.

Retours

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

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 graphique pour ce pipeline publié.

Retours

Type	Description
str	ID du graphique.

id

Obtenez l’ID de 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