PublishedPipeline 클래스

파이프라인을 구성한 Python 코드 없이 제출할 파이프라인을 나타냅니다.

또한 PublishedPipeline을 사용하여 다른 PipelineParameter 값과 입력으로 Pipeline을 다시 제출할 수 있습니다.

PublishedPipeline을 초기화합니다.

:p aram 엔드포인트 이 파이프라인에 대한 파이프라인 실행을 제출할 REST 엔드포인트 URL입니다. :type 엔드포인트: str :p aram total_run_steps: 이 파이프라인의 단계 수 :type total_run_steps: int :p aram 작업 영역: 게시된 파이프라인의 작업 영역입니다. :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

필수

이 게시된 파이프라인에 대한 그래프의 ID입니다.

description

str

필수

게시된 파이프라인에 대한 설명입니다.

version

str

필수

게시된 파이프라인 버전입니다.

published_pipeline_id

str

필수

게시된 파이프라인의 ID입니다.

status

str

필수

게시된 파이프라인의 상태('Active' 또는 'Disabled')입니다.

endpoint

str

필수

이 파이프라인에 대한 실행을 제출할 REST 엔드포인트 URL입니다.

total_run_steps

int

필수

이 파이프라인의 단계 수입니다.

workspace

Workspace

필수

게시된 파이프라인의 작업 영역입니다.

continue_on_step_failure

bool

필수

단계가 실패하는 경우 PipelineRun의 다른 단계를 계속 실행할지 여부입니다. 기본값은 false입니다.

_pipeline_provider

<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>

필수

게시된 파이프라인 공급자입니다.

kwargs

dict

필수

향후 개발을 위해 예약된 사용자 지정 키워드 인수

name

str

필수

게시된 파이프라인의 이름입니다.

graph_id

str

필수

이 게시된 파이프라인에 대한 그래프의 ID입니다.

description

str

필수

게시된 파이프라인에 대한 설명입니다.

version

str

필수

게시된 파이프라인 버전입니다.

published_pipeline_id

str

필수

게시된 파이프라인의 ID입니다.

status

str

필수

게시된 파이프라인의 상태('활성' 또는 '사용 안 함').

_pipeline_provider

<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>

필수

게시된 파이프라인 공급자입니다.

kwargs

dict

필수

향후 개발을 위해 예약된 사용자 지정 키워드 인수

설명

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입니다. 즉, 한 단계가 실패하면 파이프라인 실행이 중지되고 실행 중인 단계가 취소됩니다.

submit을 사용하여 PublishedPipeline을 제출합니다. 제출이 호출되면 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: 파이프라인 실행에 대한 매개 변수, {name: value} 사전입니다. 자세한 내용은 PipelineParameter를 참조하세요.

• parent_run_id: RunHistory에 반영되는 이 파이프라인 실행의 부모 실행을 설정하기 위해 실행 ID를 제공할 수 있습니다. 부모 실행은 제출 중인 파이프라인과 동일한 실험에 속해야 합니다.

이러한 설정을 사용하여 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 내보내기에는 ModuleSteps로 구성된 파이프라인만 지원됩니다.
submit	게시된 파이프라인을 제출합니다. 이는 submit을 사용하는 것과 같습니다. 제출된 PipelineRun을 반환합니다. 이 개체를 사용하여 실행 세부 정보를 모니터링하고 봅니다.

disable

게시된 파이프라인을 'Disabled'로 설정하고 실행할 수 없습니다.

disable()

enable

게시된 파이프라인을 'Active'로 설정하고 실행할 수 있습니다.

enable()

get

게시된 파이프라인을 가져옵니다.

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

매개 변수

workspace

Workspace

필수

게시된 파이프라인이 만들어진 작업 영역입니다.

id

str

필수

게시된 파이프라인의 ID입니다.

_workflow_provider

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

기본값: None

워크플로 공급자입니다.

_service_endpoint

str

기본값: None

서비스 엔드포인트입니다.

반환

PublishedPipeline 개체입니다.

반환 형식

PublishedPipeline

get_all

현재 작업 영역에서 게시된 모든 파이프라인을 가져옵니다.

사용되지 않음: 이 메서드는 PublishedPipeline list 메서드를 위해 더 이상 사용되지 않습니다.

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

매개 변수

workspace

Workspace

필수

게시된 파이프라인이 만들어진 작업 영역입니다.

active_only

bool

기본값: True

현재 활성 상태인 게시된 파이프라인만 반환할지 여부를 나타냅니다.

_service_endpoint

str

기본값: None

서비스 엔드포인트입니다.

반환

PublishedPipeline 개체 목록입니다.

반환 형식

list[PublishedPipeline]

get_graph

PublishedPipeline의 그래프를 가져옵니다.

get_graph(_workflow_provider=None)

매개 변수

_workflow_provider

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

기본값: None

워크플로 공급자입니다.

반환

그래프입니다.

반환 형식

Graph

get_step_names

PublishedPipeline의 단계 이름 목록을 가져옵니다.

get_step_names(_workflow_provider=None)

매개 변수

_workflow_provider

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

기본값: None

워크플로 공급자입니다.

반환

PublishedPipeline의 단계 이름 목록입니다.

반환 형식

List[str]

list

현재 작업 영역에서 게시된 모든 파이프라인을 가져옵니다.

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

매개 변수

workspace

Workspace

필수

게시된 파이프라인이 만들어진 작업 영역입니다.

active_only

bool

기본값: True

현재 활성 상태인 게시된 파이프라인만 반환할지 여부를 나타냅니다.

_service_endpoint

str

기본값: None

서비스 엔드포인트입니다.

반환

PublishedPipeline 개체 목록입니다.

반환 형식

list[PublishedPipeline]

save

파이프라인 YAML을 파일에 저장합니다.

현재 YAML 내보내기에는 ModuleSteps로 구성된 파이프라인만 지원됩니다.

save(path=None, _workflow_provider=None)

매개 변수

path

str

기본값: None

YAML을 저장할 경로입니다. 경로가 디렉터리인 경우 파이프라인 YAML 파일은 path/pipeline_name.yml에 저장됩니다. 경로가 None이면 현재 디렉터리가 사용됩니다.

_workflow_provider

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

기본값: None

워크플로 공급자입니다.

반환 형식

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

Workspace

필수

게시된 파이프라인을 제출할 작업 영역입니다.

experiment_name

str

필수

제출할 실험의 이름입니다.

pipeline_parameters

dict

기본값: None

새 값 {param name, param value}를 할당하기 위한 매개 변수 사전입니다. 자세한 내용은 PipelineParameter를 참조하세요.

_workflow_provider

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

기본값: None

워크플로 공급자입니다.

_service_endpoint

str

기본값: None

서비스 엔드포인트입니다.

parent_run_id

str

기본값: None

RunHistory에 반영된 이 파이프라인 실행의 부모 실행에 대해 설정할 선택적 실행 ID입니다. 부모 실행은 이 파이프라인이 제출되는 동일한 실험에 속해야 합니다.

continue_on_step_failure

bool

기본값: None

단계가 실패하는 경우 PipelineRun의 다른 단계를 계속 실행할지 여부를 나타냅니다. 선택 사항입니다. 제공된 경우 파이프라인의 설정을 재정의합니다.

반환

제출된 파이프라인이 실행됩니다.

반환 형식

PipelineRun

특성

continue_on_step_failure

continue_on_step_failure 설정의 값을 가져옵니다.

반환

continue_on_step_failure 설정 값입니다.

반환 형식

bool

description

게시된 파이프라인에 대한 설명을 가져옵니다.

반환

게시된 파이프라인에 대한 설명입니다.

반환 형식

str

endpoint

게시된 파이프라인을 실행하기 위한 REST 엔드포인트 URL을 가져옵니다.

반환

게시된 파이프라인을 실행하기 위한 REST 엔드포인트 URL입니다.

반환 형식

str

graph_id

이 게시된 파이프라인에 대한 그래프의 ID를 가져옵니다.

반환

그래프의 ID입니다.

반환 형식

str

id

게시된 파이프라인 ID를 가져옵니다.

반환

게시된 파이프라인의 ID입니다.

반환 형식

str

name

게시된 파이프라인의 이름을 가져옵니다.

반환

게시된 파이프라인 이름입니다.

반환 형식

str

status

게시된 파이프라인의 상태를 가져옵니다.

반환

게시된 파이프라인의 상태입니다.

반환 형식

str

total_run_steps

파이프라인의 단계 수를 가져옵니다.

반환

파이프라인의 단계 수입니다.

반환 형식

int

version

게시된 파이프라인의 버전을 가져옵니다.

반환

게시된 파이프라인의 버전입니다.

반환 형식

str