PipelineDraft Класс

Представляет изменяемый конвейер, который можно использовать для отправки выполнений и создания опубликованных конвейеров.

Используйте PipelineDrafts для выполнения итерации по конвейерам. PipelineDraft можно создать с нуля, из другого PipelineDraft или существующих конвейеров: Pipeline, PublishedPipeline или PipelineRun.

Инициализация PipelineDraft.

Наследование

builtins.object

PipelineDraft

Конструктор

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)

Параметры

Имя	Описание
workspace Обязательно	Workspace Объект рабочей области для этого PipelineDraft.
id Обязательно	str Идентификатор PipelineDraft.
name Обязательно	str Имя PipelineDraft.
description Обязательно	str Описание PipelineDraft.
experiment_name Обязательно	str Имя эксперимента для PipelineDraft.
tags Обязательно	Dict[str, str] Словарь необязательных тегов для PipelineDraft.
properties Обязательно	Dict[str, str] Словарь необязательных свойств для PipelineDraft.
graph_draft_id Обязательно	str Идентификатор черновика графа, связанного с PipelineDraft.
parent_pipeline_id Обязательно	str Идентификатор родительского PublishedPipeline.
parent_pipeline_run_id Обязательно	str Идентификатор родительского PipelineRun.
parent_step_run_ids Обязательно	list Список идентификаторов StepRun родительского PipelineRun.
parent_pipeline_draft_id Обязательно	str Идентификатор родительского PipelineDraft.
last_submitted_pipeline_run_id Обязательно	str Идентификатор последнего отправленного PipelineRun.
_pipeline_draft_provider Обязательно	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> (Только для внутреннего использования.) Поставщик PipelineDraft.
workspace Обязательно	Workspace Объект workspace для этого PipelineDraft.
id Обязательно	str Идентификатор PipelineDraft.
name Обязательно	str Имя PipelineDraft.
description Обязательно	str Описание PipelineDraft.
experiment_name Обязательно	str Имя эксперимента для PipelineDraft.
tags Обязательно	Dict[str, str] Словарь тегов для PipelineDraft.
properties Обязательно	Dict[str, str] Словарь свойств для PipelineDraft.
graph_draft_id Обязательно	str Идентификатор черновика графа, связанного с PipelineDraft.
parent_pipeline_id Обязательно	str Идентификатор родительского объекта PublishedPipeline.
parent_pipeline_run_id Обязательно	str Идентификатор родительского PipelineRun.
parent_step_run_ids Обязательно	list Список идентификаторов StepRun родительского PipelineRun.
parent_pipeline_draft_id Обязательно	str Идентификатор родительского PipelineDraft.
last_submitted_pipeline_run_id Обязательно	str Идентификатор последнего отправленного PipelineRun.
_pipeline_draft_provider Обязательно	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> Поставщик PipelineDraft.

Комментарии

PipelineDraft можно создать из Pipeline с помощью функции create. Пример представлен ниже.

   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'})

Параметр конвейера PipelineDraft.create()pipeline может быть PublishedPipeline, PipelineRun или другим PipelineDraft.

Чтобы отправить запуск из PipelineDraft, используйте метод submit_run:

   pipeline_run = pipeline_draft.submit_run()

Чтобы обновить PipelineDraft, используйте метод update. Функцию update() в черновике конвейера можно использовать для обновления имени, описания, имени эксперимента, назначений параметров конвейера, продолжения при сбое шага и конвейера, связанного с 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)

Методы

create	Создание PipelineDraft.
delete	Удаление PipelineDraft.
get	Получение PipelineDraft с заданным идентификатором.
get_graph	Получение графа, связанного с PipelineDraft.
list	Получение всех черновиков конвейера в рабочей области.
publish	Публикация PublishedPipeline из PipelineDraft.
save	Сохранение PipelineDraft YAML в файл.
submit_run	Отправка PipelineRun из PipelineDraft.
update	Обновление PipelineDraft. Указанные поля будут обновлены.

create

Создание 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)

Параметры

Имя	Описание
workspace Обязательно	Workspace Объект рабочей области, к которому будет принадлежать этот PipelineDraft.
pipeline Обязательно	PublishedPipeline или Pipeline или PipelineRun или PipelineDraft Конвейер или опубликованный конвейер.
name	str Имя PipelineDraft; требуется только при создании из Pipeline. Default value: None
description	str Описание PipelineDraft; требуется только при создании из Pipeline. Default value: None
experiment_name	str Имя эксперимента для PipelineDraft; требуется только при создании из Pipeline. Default value: None
pipeline_parameters	Dict[str, str] Необязательный словарь назначений параметров конвейера для PipelineDraft; требуется только при создании из Pipeline. Default value: None
continue_on_step_failure	bool Указывает, следует ли продолжить PipelineRun при сбое выполнения шага для PipelineDraft; требуется только при создании из Pipeline. Default value: None
tags	Dict[str, str] Необязательный словарь тегов для PipelineDraft, необходимый только при создании из Pipeline. Default value: None
properties	Dict[str, str] Необязательный словарь свойств для PipelineDraft, необходимый только при создании из Pipeline. Default value: None
_service_endpoint	str Конечная точка службы. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Только для внутреннего использования.) Поставщик рабочих процессов. Default value: None

Возвращаемое значение

Тип	Описание
PipelineDraft	Созданный PipelineDraft.

delete

Удаление PipelineDraft.

delete(_workflow_provider=None)

Параметры

Имя	Описание
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Только для внутреннего использования.) Поставщик рабочих процессов. Default value: None

get

Получение PipelineDraft с заданным идентификатором.

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

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, в которой создан объект PipelineDraft.
id Обязательно	str Идентификатор PipelineDraft.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Только для внутреннего использования.) Поставщик рабочих процессов. Default value: None
_service_endpoint	str Конечная точка службы. Default value: None

Возвращаемое значение

Тип	Описание
PipelineDraft	Объект PipelineDraft

get_graph

Получение графа, связанного с PipelineDraft.

get_graph(_workflow_provider=None)

Параметры

Имя	Описание
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Только для внутреннего использования.) Поставщик рабочих процессов. Default value: None

Возвращаемое значение

Тип	Описание
Graph	Объект Graph.

list

Получение всех черновиков конвейера в рабочей области.

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

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, в которой необходимо показать список черновиков.
tags	dict Если указан этот параметр, возвращает черновики, соответствующие указанным значениям {"tag": "value"}. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Только для внутреннего использования.) Поставщик рабочих процессов. Default value: None

Возвращаемое значение

Тип	Описание
list	Список объектов PipelineDraft.

publish

Публикация PublishedPipeline из PipelineDraft.

publish(_workflow_provider=None)

Параметры

Имя	Описание
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Только для внутреннего использования.) Поставщик рабочих процессов. Default value: None

Возвращаемое значение

Тип	Описание
PublishedPipeline	Созданный PublishedPipeline.

save

Сохранение PipelineDraft YAML в файл.

save(path=None, _workflow_provider=None)

Параметры

Имя	Описание
path	str Путь для сохранения YAML. Если путь является каталогом, файл YAML PipelineDraft сохраняется по адресу path/pipeline_name.yml. Если путь имеет значение None, используется текущий каталог. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Только для внутреннего использования.) Поставщик рабочих процессов. Default value: None

Возвращаемое значение

Тип	Описание
None

submit_run

Отправка PipelineRun из PipelineDraft.

submit_run(_workflow_provider=None)

Параметры

Имя	Описание
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Только для внутреннего использования.) Поставщик рабочих процессов. Default value: None

Возвращаемое значение

Тип	Описание
PipelineRun	Отправленный PipelineRun.

update

Обновление PipelineDraft.

Указанные поля будут обновлены.

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

Параметры

Имя	Описание
pipeline	Pipeline Обновленный конвейер для черновика. Default value: None
name	str Имя PipelineDraft. Default value: None
description	str Описание PipelineDraft. Default value: None
experiment_name	str Имя эксперимента для PipelineDraft. Default value: None
tags	Dict[str, str] Словарь тегов для PipelineDraft. Default value: None
pipeline_parameters	Dict[str, str] Назначения параметров конвейера для PipelineDraft. Default value: None
continue_on_step_failure	bool Следует ли продолжать PipelineRun, если происходит сбой выполнения шага для PipelineDraft. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Только для внутреннего использования.) Поставщик рабочих процессов. Default value: None

Атрибуты

description

Получение описания PipelineDraft.

Возвращаемое значение

Тип	Описание
str	Строка описания.

id

Получение идентификатора PipelineDraft.

Возвращаемое значение

Тип	Описание
str	Идентификатор.

last_submitted_pipeline_run_id

Получение идентификатора последнего отправленного PipelineRun в PipelineDraft.

Возвращаемое значение

Тип	Описание
str	Идентификатор PipelineRun.

name

Получение имени PipelineDraft.

Возвращаемое значение

Тип	Описание
str	Имя.

parent_pipeline_draft_id

Получение идентификатора родительского PipelineDraft в PipelineDraft.

Возвращаемое значение

Тип	Описание
str	Идентификатор PipelineDraft.

parent_pipeline_id

Получение идентификатора родительского PublishedPipeline в PipelineDraft.

Возвращаемое значение

Тип	Описание
str	Идентификатор PublishedPipeline.

parent_pipeline_run_id

Получение идентификатора родительского PipelineRun в PipelineDraft.

Возвращаемое значение

Тип	Описание
str	Идентификатор PipelineRun.

parent_step_run_ids

Получение идентификатора родительского PipelineRun в PipelineDraft.

Возвращаемое значение

Тип	Описание
list	Список идентификаторов StepRun.

properties

Получение свойств PipelineDraft.

Возвращаемое значение

Тип	Описание
dict	Словарь свойств.

tags

Получение тегов PipelineDraft.

Возвращаемое значение

Тип	Описание
dict	Словарь тегов.