Поделиться через


PublishedPipeline Класс

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

Кроме того, PublishedPipeline можно использовать для повторной отправки Pipeline с другими значениями PipelineParameter и входными данными.

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

:p конечная точкаaram— URL-адрес конечной точки REST для выполнения конвейера отправки для этого конвейера. :type endpoint: str :p aram total_run_steps: количество шагов в этом конвейере :type total_run_steps: int :p aram workspace: рабочая область опубликованного конвейера. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: следует ли продолжить выполнение других шагов в PipelineRun

Если шаг завершается сбоем, по умолчанию используется значение false.

Наследование
azureml.core._portal.HasPipelinePortal
PublishedPipeline

Конструктор

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

Параметры

Имя Описание
name
Обязательно
str

Имя опубликованного конвейера.

graph_id
Обязательно
str

Идентификатор графа для этого опубликованного конвейера.

description
Обязательно
str

Описание опубликованного конвейера.

version
Обязательно
str

Версия опубликованного конвейера.

published_pipeline_id
Обязательно
str

Идентификатор опубликованного конвейера.

status
Обязательно
str

Состояние опубликованного конвейера (Active или Disabled).

endpoint
Обязательно
str

URL-адрес конечной точки REST для отправки выполнений для этого конвейера.

total_run_steps
Обязательно
int

Число этапов в этом конвейере.

workspace
Обязательно

Рабочая область опубликованного конвейера.

continue_on_step_failure
Обязательно

Следует ли продолжать выполнение других шагов в PipelineRun, если шаг завершается ошибкой. Значение по умолчанию — false.

_pipeline_provider
Обязательно
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>

Поставщик опубликованного конвейера.

kwargs
Обязательно

Пользовательские аргументы ключевого слова, зарезервированные для будущей разработки

name
Обязательно
str

Имя опубликованного конвейера.

graph_id
Обязательно
str

Идентификатор графа для этого опубликованного конвейера.

description
Обязательно
str

Описание опубликованного конвейера.

version
Обязательно
str

Версия опубликованного конвейера.

published_pipeline_id
Обязательно
str

Идентификатор опубликованного конвейера.

status
Обязательно
str

Состояние опубликованного конвейера ("Активный" или "Отключен").

_pipeline_provider
Обязательно
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>

Поставщик опубликованного конвейера.

kwargs
Обязательно

Пользовательские аргументы ключевого слова, зарезервированные для будущей разработки

Комментарии

PublishedPipeline можно создать из Pipeline или PipelineRun.

Пример публикации из конвейера выглядит следующим образом:


   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)

Для публикации из PipelineRun используйте следующее:


   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)

Примечание. Параметр continue_on_step_failure указывает, будет ли продолжаться выполнение этапов в конвейере в случае сбоя одного этапа. Значение по умолчанию — False. Это означает, что при сбое одного этапа выполнение конвейера будет прекращено, а все выполняемые этапы — отменены.

Отправка PublishedPipeline с помощью submit. При вызове метода Submit создается PipelineRun, который, в свою очередь, создает объекты StepRun для каждого этапа рабочего процесса.

Пример для отправки PublishedPipeline приведен ниже.


   from azureml.pipeline.core import PublishedPipeline

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

Существует ряд необязательных параметров, которые можно указать при отправке PublishedPipeline. Они перечислены ниже.

  • continue_on_step_failure — указывает, следует ли продолжать выполнение других этапов в PipelineRun, если этап завершается ошибкой. Выполнение будет продолжено только для этапов, не имеющих зависимости от выходных данных этапа, на котором произошел сбой. Если этот параметр задан, то он переопределяет параметр в конвейере.

  • pipeline_parameters — параметры для выполнения конвейера, словарь {имя: значение}. Дополнительные сведения см. в статье PipelineParameter.

  • parent_run_id — можно указать идентификатор выполнения, чтобы задать родительское выполнение для этого выполнения конвейера, которое отображается в RunHistory. Родительское выполнение должно относиться к тому же эксперименту, в который отправляется этот конвейер.

Пример отправки PublishedPipeline с использованием этих параметров выглядит следующим образом:


   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>")

Все опубликованные конвейеры используют конечную точку REST. Конечная точка конвейера позволяет активировать конвейер из внешних систем, включая клиенты, не относящиеся к Python. Дополнительные сведения о проверке подлинности при вызове конечных точек REST см. здесь: https://aka.ms/pl-restep-auth.

Применение конечной точки обеспечивает управляемую повторяемость, например, для сценариев пакетной оценки и переобучения. Для получения дополнительной информации см. https://aka.ms/pl-first-pipeline.

Методы

disable

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

enable

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

get

Получение опубликованного конвейера.

get_all

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

НЕ РЕКОМЕНДУЕТСЯ. Этот метод является нерекомендуемым. Используйте вместо него метод PublishedPipeline list.

get_graph

Получение графа PublishedPipeline.

get_step_names

Получение списка имен этапов в PublishedPipeline.

list

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

save

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

В настоящее время экспорт YAML поддерживается только для конвейеров, состоящих из объектов ModuleStep.

submit

Отправка опубликованного конвейера. Это эквивалентно использованию submit.

Возвращает отправленный PipelineRun. Используйте этот объект, чтобы отслеживать и просматривать сведения о выполнении.

disable

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

disable()

enable

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

enable()

get

Получение опубликованного конвейера.

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

Параметры

Имя Описание
workspace
Обязательно

Рабочая область, в которой был создан опубликованный конвейер.

id
Обязательно
str

Идентификатор опубликованного конвейера.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Поставщик рабочего процесса.

Default value: None
_service_endpoint
str

Конечная точка службы.

Default value: None

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

Тип Описание

Объект PublishedPipeline.

get_all

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

НЕ РЕКОМЕНДУЕТСЯ. Этот метод является нерекомендуемым. Используйте вместо него метод PublishedPipeline list.

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

Параметры

Имя Описание
workspace
Обязательно

Рабочая область, в которой был создан опубликованный конвейер.

active_only

Указывает, следует ли возвращать только опубликованные конвейеры, которые сейчас активны.

Default value: True
_service_endpoint
str

Конечная точка службы.

Default value: None

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

Тип Описание

Список объектов PublishedPipeline.

get_graph

Получение графа PublishedPipeline.

get_graph(_workflow_provider=None)

Параметры

Имя Описание
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Поставщик рабочего процесса.

Default value: None

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

Тип Описание

Граф.

get_step_names

Получение списка имен этапов в PublishedPipeline.

get_step_names(_workflow_provider=None)

Параметры

Имя Описание
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Поставщик рабочего процесса.

Default value: None

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

Тип Описание

Список имен этапов в PublishedPipeline.

list

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

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

Параметры

Имя Описание
workspace
Обязательно

Рабочая область, в которой был создан опубликованный конвейер.

active_only

Указывает, следует ли возвращать только опубликованные конвейеры, которые сейчас активны.

Default value: True
_service_endpoint
str

Конечная точка службы.

Default value: None

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

Тип Описание

Список объектов PublishedPipeline.

save

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

В настоящее время экспорт YAML поддерживается только для конвейеров, состоящих из объектов ModuleStep.

save(path=None, _workflow_provider=None)

Параметры

Имя Описание
path
str

Путь для сохранения YAML. Если путь ведет к каталогу, файл YAML конвейера сохраняется по адресу path/pipeline_name.yml. Если путь имеет значение None, используется текущий каталог.

Default value: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Поставщик рабочего процесса.

Default value: None

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

Тип Описание

submit

Отправка опубликованного конвейера. Это эквивалентно использованию submit.

Возвращает отправленный PipelineRun. Используйте этот объект, чтобы отслеживать и просматривать сведения о выполнении.

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

Параметры

Имя Описание
workspace
Обязательно

Рабочая область для отправки опубликованного конвейера.

experiment_name
Обязательно
str

Имя эксперимента для отправки.

pipeline_parameters

Словарь параметров для назначения новых значений {имя параметра, значение параметра}. Дополнительные сведения см. в статье PipelineParameter.

Default value: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

Поставщик рабочего процесса.

Default value: None
_service_endpoint
str

Конечная точка службы.

Default value: None
parent_run_id
str

Необязательный идентификатор выполнения, задаваемый для родительского выполнения этого выполнения конвейера, который отображается в RunHistory. Родительское выполнение должно относиться к тому же эксперименту, в который отправляется этот конвейер.

Default value: None
continue_on_step_failure

(Необязательный.) Указывает, следует ли продолжать выполнение других этапов в PipelineRun, если этап завершается ошибкой. Если параметр указан, он переопределит параметр конвейера.

Default value: None

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

Тип Описание

Отправленное выполнение конвейера.

Атрибуты

continue_on_step_failure

Получение значения параметра continue_on_step_failure.

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

Тип Описание

Значение параметра continue_on_step_failure.

description

Получение описания опубликованного конвейера.

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

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

Описание опубликованного конвейера.

endpoint

Получение URL-адреса конечной точки REST для выполнения опубликованного конвейера.

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

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

URL-адрес конечной точки REST для выполнения опубликованного конвейера.

graph_id

Получение идентификатора графа для этого опубликованного конвейера.

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

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

Идентификатор графа.

id

Получение идентификатора опубликованного конвейера.

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

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

Идентификатор опубликованного конвейера.

name

Получение имени опубликованного конвейера.

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

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

Имя опубликованного конвейера.

status

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

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

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

Состояние опубликованного конвейера.

total_run_steps

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

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

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

Число этапов в конвейере.

version

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

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

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

Версия опубликованного конвейера.