PipelineRun 클래스

참조

Pipeline의 실행을 나타냅니다.

이 클래스는 파이프라인 실행이 제출되면 관리, 상태 확인, 실행 세부 정보 검색에 사용할 수 있습니다. get_steps를 사용하여 파이프라인 실행에 의해 생성된 StepRun 개체를 검색합니다. 다른 용도로는 파이프라인 실행과 연결된 Graph 개체 검색, 파이프라인 실행 상태 가져오기, 실행 완료 대기 등이 있습니다.

파이프라인 실행을 초기화합니다.

상속: Run

PipelineRun

생성자

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

매개 변수

experiment: Experiment

필수

파이프라인 실행과 연결된 실험 개체입니다.

run_id: str

필수

파이프라인 실행의 실행 ID입니다.

_service_endpoint: str

기본값: None

연결할 엔드포인트입니다.

experiment: Experiment

필수

파이프라인 실행과 연결된 실험 개체입니다.

run_id: str

필수

파이프라인 실행의 실행 ID입니다.

_service_endpoint: str

필수

연결할 엔드포인트입니다.

설명

submit를 통해 Pipeline을 제출할 때 PipelineRun 개체가 반환됩니다. Experiment의 메서드입니다. 파이프라인을 만들고 제출하는 방법에 대한 자세한 내용은 https://aka.ms/pl-first-pipeline을 참조하세요.

다음과 같이 실행이 제출된 Experiment 및 PipelineRun ID를 사용하여 PipelineRun을 인스턴스화할 수도 있습니다.


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

PipelineRun을 사용하는 경우 다음을 사용합니다.

wait_for_completion - 실행 상태를 모니터링하고 필요에 따라 실행 로그를 스트리밍합니다.
get_status - 실행 상태를 가져옵니다.
cancel - 진행 중인 PipelineRun을 취소합니다.
get_steps - 생성된 StepRuns를 나열합니다. PipelineRun은 파이프라인의 각 단계에 대해 StepRun을 생성합니다.

메서드

cancel	진행 중인 실행을 취소합니다.
child_run	파이프라인 실행에 대한 자식 실행을 만듭니다. 이 메서드는 PipelineRun에 대해 구현되지 않습니다.
complete	파이프라인 실행을 완료로 표시합니다. 이 메서드는 PipelineRun에 대해 구현되지 않습니다. 이 메서드는 파이프라인에 대해 지원되지 않습니다. 완료/실패 상태는 Azure ML 백 엔드에서 관리됩니다.
fail	파이프라인 실행을 실패로 표시합니다. 이 메서드는 PipelineRun에 대해 구현되지 않습니다. 이 메서드는 파이프라인에 대해 지원되지 않습니다. 완료/실패 상태는 Azure ML 백 엔드에서 관리됩니다.
find_step_run	파이프라인에서 이름으로 단계 실행을 찾습니다.
get	실행 ID에 따라 파이프라인 실행을 가져옵니다.
get_graph	파이프라인 실행의 그래프를 가져옵니다.
get_pipeline_output	지정된 파이프라인 출력에 대한 PortDataReference를 가져옵니다.
get_pipeline_runs	게시된 파이프라인에서 생성된 파이프라인 실행을 가져옵니다.
get_status	서비스에서 파이프라인 실행의 최신 상태를 가져옵니다. 일반적으로 반환되는 값으로는 "실행", "완료", "실패"가 있습니다.
get_steps	실행을 완료하거나 시작한 모든 파이프라인 단계에 대한 단계 실행을 가져옵니다.
get_tags	실행에 대한 태그 집합을 가져옵니다.
publish_pipeline	파이프라인을 게시하고 다시 실행할 수 있도록 합니다. 이 함수에서 반환된 PublishedPipeline 개체에서 파이프라인 엔드포인트를 가져올 수 있습니다. 파이프라인 엔드포인트를 사용하면 REST 호출을 사용하여 외부 애플리케이션에서 파이프라인을 호출할 수 있습니다. REST 엔드포인트를 호출할 때 인증하는 방법에 대한 자세한 내용은 https://aka.ms/pl-restep-auth를 참조하세요. 파이프라인 실행과 연결된 원래 파이프라인은 게시된 파이프라인의 기반으로 사용됩니다.
save	파이프라인 YAML을 파일에 저장합니다.
wait_for_completion	이 파이프라인 실행이 완료될 때까지 기다립니다. 대기 후 상태를 반환합니다.

cancel

진행 중인 실행을 취소합니다.

cancel()

child_run

파이프라인 실행에 대한 자식 실행을 만듭니다. 이 메서드는 PipelineRun에 대해 구현되지 않습니다.

child_run(name=None, run_id=None, outputs=None)

매개 변수

name: str

기본값: None

자식의 선택적 이름입니다.

run_id: str

기본값: None

자식에 대한 선택적 실행 ID입니다. 그렇지 않으면 기본값을 사용합니다.

outputs: str

기본값: None

자식에 대해 추적할 선택적 출력 디렉터리입니다.

반환

자식 실행입니다.

반환 형식

Run

예외

NotImplementedError

complete

파이프라인 실행을 완료로 표시합니다. 이 메서드는 PipelineRun에 대해 구현되지 않습니다.

이 메서드는 파이프라인에 대해 지원되지 않습니다. 완료/실패 상태는 Azure ML 백 엔드에서 관리됩니다.

complete()

예외

NotImplementedError

fail

파이프라인 실행을 실패로 표시합니다. 이 메서드는 PipelineRun에 대해 구현되지 않습니다.

이 메서드는 파이프라인에 대해 지원되지 않습니다. 완료/실패 상태는 Azure ML 백 엔드에서 관리됩니다.

fail()

예외

NotImplementedError

find_step_run

파이프라인에서 이름으로 단계 실행을 찾습니다.

find_step_run(name)

매개 변수

name: str

필수

찾을 단계의 이름입니다.

반환

제공된 이름을 가진 StepRun 개체 목록입니다.

반환 형식

list

get

실행 ID에 따라 파이프라인 실행을 가져옵니다.

static get(workspace, run_id, _service_endpoint=None)

매개 변수

workspace: Workspace

필수

파이프라인과 연결된 작업 영역입니다.

run_id: str

필수

파이프라인 실행의 ID입니다.

_service_endpoint: str

기본값: None

연결할 엔드포인트입니다.

반환

PipelineRun 개체

반환 형식

PipelineRun

get_graph

파이프라인 실행의 그래프를 가져옵니다.

get_graph()

반환

그래프입니다.

반환 형식

Graph

get_pipeline_output

지정된 파이프라인 출력에 대한 PortDataReference를 가져옵니다.

get_pipeline_output(pipeline_output_name)

매개 변수

pipeline_output_name: str

필수

가져올 파이프라인 출력의 이름입니다.

반환

파이프라인 출력 데이터를 나타내는 PortDataReference입니다.

반환 형식

PortDataReference

get_pipeline_runs

게시된 파이프라인에서 생성된 파이프라인 실행을 가져옵니다.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

매개 변수

workspace: Workspace

필수

파이프라인과 연결된 작업 영역입니다.

pipeline_id: str

필수

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

_service_endpoint: str

기본값: None

연결할 엔드포인트입니다.

반환

PipelineRun 개체의 목록입니다.

반환 형식

list

get_status

서비스에서 파이프라인 실행의 최신 상태를 가져옵니다.

일반적으로 반환되는 값으로는 "실행", "완료", "실패"가 있습니다.

get_status()

반환

문자열로 나타낸 최신 상태입니다.

반환 형식

str

설명

NotStarted - 클라우드 제출 전에 임시 상태 클라이언트 쪽 실행 개체입니다.
Running - 컴퓨팅 대상에서 작업이 실행되기 시작했습니다.
Failed - 실행이 실패했습니다. 일반적으로 실행의 오류 속성은 이유에 대한 세부 정보를 제공합니다.
Finished - 실행이 성공적으로 완료되었습니다.
Canceled - 취소 요청에 따라 실행이 성공적으로 취소됩니다.


   run = experiment.submit(config)
   while run.get_status() not in ['Finished', 'Failed']: # For example purposes only, not exhaustive
       print('Run {} not in terminal state'.format(run.id))
       time.sleep(10)

get_steps

실행을 완료하거나 시작한 모든 파이프라인 단계에 대한 단계 실행을 가져옵니다.

get_steps()

반환

StepRun 개체의 목록입니다.

반환 형식

list

get_tags

실행에 대한 태그 집합을 가져옵니다.

get_tags()

반환

실행에 대한 태그의 사전입니다.

반환 형식

dict

publish_pipeline

파이프라인을 게시하고 다시 실행할 수 있도록 합니다.

이 함수에서 반환된 PublishedPipeline 개체에서 파이프라인 엔드포인트를 가져올 수 있습니다. 파이프라인 엔드포인트를 사용하면 REST 호출을 사용하여 외부 애플리케이션에서 파이프라인을 호출할 수 있습니다. REST 엔드포인트를 호출할 때 인증하는 방법에 대한 자세한 내용은 https://aka.ms/pl-restep-auth를 참조하세요.

파이프라인 실행과 연결된 원래 파이프라인은 게시된 파이프라인의 기반으로 사용됩니다.

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

매개 변수

name: str

필수

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

description: str

필수

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

version: str

필수

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

continue_on_step_failure: bool

기본값: None

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

kwargs: dict

필수

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

반환

생성하여 게시된 파이프라인입니다.

반환 형식

PublishedPipeline

save

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

save(path=None)

매개 변수

path: str

기본값: None

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

반환 형식

None

wait_for_completion

이 파이프라인 실행이 완료될 때까지 기다립니다.

대기 후 상태를 반환합니다.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

매개 변수

show_output: bool

기본값: True

sys.stdout에 파이프라인 실행 상태를 표시할지 여부를 나타냅니다.

timeout_seconds: int

기본값: 9223372036854775807

시간이 초과되기 전에 대기하는 시간(초)입니다.

raise_on_error: bool

기본값: True

실행이 실패 상태일 때 오류를 발생할지 여부를 나타냅니다.

반환

최종 상태입니다.

반환 형식

str

PipelineRun 클래스

생성자

매개 변수

설명

메서드

cancel

child_run

매개 변수

반환

반환 형식

예외

complete

예외

fail

예외

find_step_run

매개 변수

반환

반환 형식

get

매개 변수

반환

반환 형식

get_graph

반환

반환 형식

get_pipeline_output

매개 변수

반환

반환 형식

get_pipeline_runs

매개 변수

반환

반환 형식

get_status

반환

반환 형식

설명

get_steps

반환

반환 형식

get_tags

반환

반환 형식

publish_pipeline

매개 변수

반환

반환 형식

save

매개 변수

반환 형식

wait_for_completion

매개 변수

반환

반환 형식

피드백

피드백

추가 리소스