PipelineDraft Classe

Référence

Représente un pipeline mutable qui peut être utilisé pour envoyer des exécutions et créer des pipelines publiés.

Utilisez PipelineDrafts pour effectuer une itération sur Pipelines. Il est possible de créer des PipelineDrafts ex nihilo, à partir d’un autre PipelineDraft ou de pipelines existants : Pipeline, PublishedPipeline ou PipelineRun.

Initialiser PipelineDraft.

Héritage: builtins.object

PipelineDraft

Constructeur

PipelineDraft(workspace, id, name=None, description=None, experiment_name=None, tags=None, properties=None, graph_draft_id=None, parent_pipeline_id=None, parent_pipeline_run_id=None, parent_step_run_ids=None, parent_pipeline_draft_id=None, last_submitted_pipeline_run_id=None, _pipeline_draft_provider=None)

Paramètres

Nom	Description
workspace Obligatoire	Workspace Objet espace de travail de ce PipelineDraft.
id Obligatoire	str ID du PipelineDraft.
name Obligatoire	str Nom du PipelineDraft.
description Obligatoire	str Description du PipelineDraft.
experiment_name Obligatoire	str Nom d’expérience du PipelineDraft.
tags Obligatoire	Dict[str, str] Dictionnaire d’étiquettes facultatif du PipelineDraft.
properties Obligatoire	Dict[str, str] Dictionnaire de propriétés facultatif du PipelineDraft.
graph_draft_id Obligatoire	str ID de brouillon de graphe associé au PipelineDraft.
parent_pipeline_id Obligatoire	str ID du PublishedPipeline parent.
parent_pipeline_run_id Obligatoire	str ID du PipelineRun parent.
parent_step_run_ids Obligatoire	list Liste des ID de StepRun du PipelineRun parent.
parent_pipeline_draft_id Obligatoire	str ID du PipelineDraft parent.
last_submitted_pipeline_run_id Obligatoire	str ID du dernier PipelineRun envoyé.
_pipeline_draft_provider Obligatoire	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> (Usage interne uniquement.) Fournisseur PipelineDraft.
workspace Obligatoire	Workspace Objet Workspace pour ce PipelineDraft.
id Obligatoire	str ID du PipelineDraft.
name Obligatoire	str Nom du PipelineDraft.
description Obligatoire	str Description du PipelineDraft.
experiment_name Obligatoire	str Nom d’expérience du PipelineDraft.
tags Obligatoire	Dict[str, str] Dictionnaire de balises pour pipelineDraft.
properties Obligatoire	Dict[str, str] Dictionnaire de propriétés pour PipelineDraft.
graph_draft_id Obligatoire	str ID du brouillon de graphique associé à PipelineDraft.
parent_pipeline_id Obligatoire	str ID du parent PublishedPipeline.
parent_pipeline_run_id Obligatoire	str ID du PipelineRun parent.
parent_step_run_ids Obligatoire	list Liste des ID StepRun du PipelineRun parent.
parent_pipeline_draft_id Obligatoire	str ID du PipelineDraft parent.
last_submitted_pipeline_run_id Obligatoire	str ID du dernier PipelineRun envoyé.
_pipeline_draft_provider Obligatoire	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> Fournisseur du PipelineDraft.

Remarques

Un PipelineDraft peut être créé à partir d’un Pipeline à l’aide de la fonction create. Voici un exemple :


   from azureml.pipeline.core import Pipeline, PipelineDraft
   from azureml.pipeline.steps import PythonScriptStep

   train_step = PythonScriptStep(name="Training_Step",
                                 script_name="train.py",
                                 compute_target=aml_compute_target,
                                 source_directory=".")
   pipeline = Pipeline(workspace=ws, steps=[train_step])
   pipeline_draft = PipelineDraft.create(workspace=ws,
                                         name="TestPipelineDraft",
                                         description="draft description",
                                         experiment_name="helloworld",
                                         pipeline=pipeline,
                                         continue_on_step_failure=True,
                                         tags={'dev': 'true'},
                                         properties={'train': 'value'})

Le paramètre de pipeline de PipelineDraft.create() peut également être un PublishedPipeline, un PipelineRun ou un autre PipelineDraft.

Pour soumettre une exécution à partir d’un PipelineDraft, utilisez la méthode submit_run :


   pipeline_run = pipeline_draft.submit_run()

Pour mettre à jour un PipelineDraft, utilisez la méthode update. La fonction update() d’un brouillon de pipeline peut être utilisée pour mettre à jour le nom, la description, le nom d’expérience, les affectations de paramètres de pipeline, le paramètre de continuation en cas d’échec d’une étape et le pipeline associés au PipelineDraft.


   new_train_step = PythonScriptStep(name="New_Training_Step",
                                     script_name="train.py",
                                     compute_target=aml_compute_target,
                                     source_directory=source_directory)

   new_pipeline = Pipeline(workspace=ws, steps=[new_train_step])

   pipeline_draft.update(name="UpdatedPipelineDraft",
                         description="has updated train step",
                         pipeline=new_pipeline)

Méthodes

create	Crée un PipelineDraft.
delete	Supprime le PipelineDraft.
get	Obtient le PipelineDraft avec l’ID donné.
get_graph	Obtient le graphe associé au PipelineDraft.
list	Obtient tous les brouillons de pipeline dans un espace de travail.
publish	Publie un PublishedPipeline à partir du PipelineDraft.
save	Enregistre le code YAML du PipelineDraft dans un fichier.
submit_run	Envoie un PipelineRun à partir du PipelineDraft.
update	Met à jour un PipelineDraft. Les champs fournis seront mis à jour.

create

Crée un PipelineDraft.

static create(workspace, pipeline, name=None, description=None, experiment_name=None, pipeline_parameters=None, continue_on_step_failure=None, tags=None, properties=None, _workflow_provider=None, _service_endpoint=None)

Paramètres

Nom	Description
workspace Obligatoire	Workspace Objet espace de travail auquel va appartenir ce PipelineDraft.
pipeline Obligatoire	PublishedPipeline ou Pipeline ou PipelineRun ou PipelineDraft Pipeline ou pipeline publié.
name	str Nom du PipelineDraft ; nécessaire uniquement lors de la création à partir d’un Pipeline. Valeur par défaut: None
description	str Description du PipelineDraft ; nécessaire uniquement lors de la création à partir d’un Pipeline. Valeur par défaut: None
experiment_name	str Nom d’expérience du PipelineDraft ; nécessaire uniquement lors de la création à partir d’un Pipeline. Valeur par défaut: None
pipeline_parameters	Dict[str, str] Dictionnaire facultatif des affectations de paramètres de pipeline pour le PipelineDraft ; nécessaire uniquement lors de la création à partir d’un Pipeline. Valeur par défaut: None
continue_on_step_failure	bool Indique de continuer ou non un PipelineRun quand une exécution d’étape ne parvient pas à être définie pour le PipelineDraft ; nécessaire uniquement lors de la création à partir d’un Pipeline. Valeur par défaut: None
tags	Dict[str, str] Dictionnaire des étiquettes facultatif pour le PipelineDraft ; nécessaire uniquement lors de la création à partir d’un Pipeline. Valeur par défaut: None
properties	Dict[str, str] Dictionnaire des propriétés facultatif pour le PipelineDraft ; nécessaire uniquement lors de la création à partir d’un Pipeline. Valeur par défaut: None
_service_endpoint	str Point de terminaison du service. Valeur par défaut: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Usage interne uniquement.) Fournisseur de flux de travail. Valeur par défaut: None

Retours

Type	Description
PipelineDraft	PipelineDraft créé.

delete

Supprime le PipelineDraft.

delete(_workflow_provider=None)

Paramètres

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

get

Obtient le PipelineDraft avec l’ID donné.

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

Paramètres

Nom	Description
workspace Obligatoire	Workspace Espace de travail dans lequel le PipelineDraft a été créé.
id Obligatoire	str ID du PipelineDraft.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Usage interne uniquement.) Fournisseur de flux de travail. Valeur par défaut: None
_service_endpoint	str Point de terminaison du service. Valeur par défaut: None

Retours

Type	Description
PipelineDraft	Objet PipelineDraft

get_graph

Obtient le graphe associé au PipelineDraft.

get_graph(_workflow_provider=None)

Paramètres

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

Retours

Type	Description
Graph	Objet Graph.

list

Obtient tous les brouillons de pipeline dans un espace de travail.

static list(workspace, tags=None, _workflow_provider=None)

Paramètres

Nom	Description
workspace Obligatoire	Workspace Espace de travail à partir duquel lister les brouillons.
tags	dict Si la valeur est spécifiée, retourne les brouillons correspondant à la valeur {"tag": "value"} spécifiée. Valeur par défaut: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Usage interne uniquement.) Fournisseur de flux de travail. Valeur par défaut: None

Retours

Type	Description
list	Liste des objets PipelineDraft.

publish

Publie un PublishedPipeline à partir du PipelineDraft.

publish(_workflow_provider=None)

Paramètres

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

Retours

Type	Description
PublishedPipeline	PublishedPipeline créé.

save

Enregistre le code YAML du PipelineDraft dans un fichier.

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 du PipelineDraft est enregistré dans chemin/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> (Usage interne uniquement.) Fournisseur de flux de travail. Valeur par défaut: None

Retours

Type	Description
None

submit_run

Envoie un PipelineRun à partir du PipelineDraft.

submit_run(_workflow_provider=None)

Paramètres

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

Retours

Type	Description
PipelineRun	PipelineRun envoyé.

update

Met à jour un PipelineDraft.

Les champs fournis seront mis à jour.

update(pipeline=None, name=None, description=None, experiment_name=None, tags=None, pipeline_parameters=None, continue_on_step_failure=None, _workflow_provider=None)

Paramètres

Nom	Description
pipeline	Pipeline Pipeline mis à jour pour le brouillon. Valeur par défaut: None
name	str Nom du PipelineDraft. Valeur par défaut: None
description	str Description du PipelineDraft. Valeur par défaut: None
experiment_name	str Nom d’expérience du PipelineDraft. Valeur par défaut: None
tags	Dict[str, str] Dictionnaire d’étiquettes du PipelineDraft. Valeur par défaut: None
pipeline_parameters	Dict[str, str] Affectations de paramètres de pipeline pour le PipelineDraft. Valeur par défaut: None
continue_on_step_failure	bool Indique de continuer ou non le PipelineRun quand une exécution d’étape ne parvient pas à être définie pour le PipelineDraft. Valeur par défaut: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Usage interne uniquement.) Fournisseur de flux de travail. Valeur par défaut: None

Attributs

description

Obtient la description du PipelineDraft.

Retours

Type	Description
str	Chaîne de description.

id

Obtient l’ID du PipelineDraft.

Retours

Type	Description
str	ID.

last_submitted_pipeline_run_id

Obtient l’ID du dernier PipelineRun envoyé du PipelineDraft.

Retours

Type	Description
str	ID de PipelineRun.

name

Teste le nom du PipelineDraft.

Retours

Type	Description
str	Nom.

parent_pipeline_draft_id

Obtient l’ID du PipelineDraft parent du PipelineDraft.

Retours

Type	Description
str	ID de PipelineDraft.

parent_pipeline_id

Obtient l’ID du PublishedPipeline parent du PipelineDraft.

Retours

Type	Description
str	ID de PublishedPipeline.

parent_pipeline_run_id

Obtient l’ID du PipelineRun parent du PipelineDraft.

Retours

Type	Description
str	ID de PipelineRun.

parent_step_run_ids

Obtient la liste des ID de StepRun du PipelineRun parent du PipelineDraft.

Retours

Type	Description
list	Liste des ID de StepRun.

properties

Obtient les propriétés du PipelineDraft.

Retours

Type	Description
dict	Dictionnaire des propriétés.

Partager via

PipelineDraft Classe

Constructeur

Paramètres

Remarques

Méthodes

create

Paramètres

Retours

delete

Paramètres

get

Paramètres

Retours

get_graph

Paramètres

Retours

list

Paramètres

Retours

publish

Paramètres

Retours

save

Paramètres

Retours

submit_run

Paramètres

Retours

update

Paramètres

Attributs

description

Retours

id

Retours

last_submitted_pipeline_run_id

Retours

name

Retours

parent_pipeline_draft_id

Retours

parent_pipeline_id

Retours

parent_pipeline_run_id

Retours

parent_step_run_ids

Retours

properties

Retours

tags

Retours

Commentaires

Ressources supplémentaires