다음을 통해 공유

PipelineJob 클래스

  • 참조

파이프라인 작업.

이 클래스를 직접 인스턴스화해서는 안 됩니다. 대신 @pipeline 데코레이터를 사용하여 PipelineJob을 만들어야 합니다.

] :p aram 컴퓨팅: 빌드된 파이프라인의 컴퓨팅 대상 이름입니다. 기본값은 None :type compute: str :p aram 태그: 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 기본값은 없음 :type 태그: dict[str, str] :p aram kwargs: 추가 구성 매개 변수 사전입니다. 기본값은 None :type kwargs: dict입니다.

상속
azure.ai.ml.entities._job.job.Job
PipelineJob
azure.ai.ml.entities._mixins.YamlTranslatableMixin
PipelineJob
azure.ai.ml.entities._job.pipeline._io.mixin.PipelineJobIOMixin
PipelineJob
azure.ai.ml.entities._validation.path_aware_schema.PathAwareSchemaValidatableMixin
PipelineJob

생성자

PipelineJob(*, component: str | PipelineComponent | None = None, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, Output] | None = None, name: str | None = None, description: str | None = None, display_name: str | None = None, experiment_name: str | None = None, jobs: Dict[str, BaseNode] | None = None, settings: PipelineJobSettings | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, compute: str | None = None, tags: Dict[str, str] | None = None, **kwargs)

매개 변수

component
Union[str, PipelineComponent]
필수

파이프라인 구성 요소 버전입니다. 필드는 'jobs'와 함께 사용할 수 없습니다.

inputs
dict[str, Union[<xref:azure.ai.ml.entities.Input>, str, bool, int, float]]
필수

파이프라인 작업에 대한 입력입니다.

outputs
dict[str, <xref:azure.ai.ml.entities.Output>]
필수

파이프라인 작업의 출력입니다.

name
str
필수

PipelineJob의 이름입니다. 기본값은 없음입니다.

description
str
필수

파이프라인 작업에 대한 설명입니다. 기본값은 없음입니다.

display_name
str
필수

파이프라인 작업의 표시 이름입니다. 기본값은 없음입니다.

experiment_name
str
필수

작업이 만들어질 실험의 이름입니다. None이 제공되면 실험이 현재 디렉터리로 설정됩니다. 기본값은 없음입니다.

jobs
dict[str, <xref:azure.ai.ml.entities._builders.BaseNode>]
필수

구성 요소 개체에 대한 파이프라인 구성 요소 노드 이름입니다. 기본값은 없음입니다.

settings
PipelineJobSettings
필수

파이프라인 작업의 설정입니다. 기본값은 없음입니다.

identity
Union[ ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration
필수

컴퓨팅에서 실행하는 동안 학습 작업이 사용할 ID입니다. 기본값은 없음입니다.

예제

이 클래스를 사용하여 파이프라인을 만드는 방법을 보여 줍니다.


   from azure.ai.ml.entities import PipelineJob, PipelineJobSettings

   pipeline_job = PipelineJob(
       description="test pipeline job",
       tags={},
       display_name="test display name",
       experiment_name="pipeline_job_samples",
       properties={},
       settings=PipelineJobSettings(force_rerun=True, default_compute="cpu-cluster"),
       jobs={"component1": component_func(component_in_number=1.0, component_in_path=uri_file_input)},
   )
   ml_client.jobs.create_or_update(pipeline_job)

메서드

dump

YAML 형식의 파일로 작업 콘텐츠를 덤프합니다.

dump

YAML 형식의 파일로 작업 콘텐츠를 덤프합니다.

dump(dest: str | PathLike | IO, **kwargs) -> None

매개 변수

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
필수

YAML 콘텐츠를 쓸 로컬 경로 또는 파일 스트림입니다. dest가 파일 경로인 경우 새 파일이 만들어집니다. dest가 열려 있는 파일인 경우 파일이 직접 에 기록됩니다.

kwargs
dict

YAML serializer에 전달할 추가 인수입니다.

예외

FileExistsError

dest가 파일 경로이고 파일이 이미 있는 경우 발생합니다.

IOError

dest가 열려 있는 파일이고 파일을 쓸 수 없는 경우 발생합니다.

특성

base_path

리소스의 기본 경로입니다.

반환

리소스의 기본 경로입니다.

반환 형식

str

creation_context

리소스의 만들기 컨텍스트입니다.

반환

리소스에 대한 만들기 메타데이터입니다.

반환 형식

Optional[SystemData]

id

리소스 ID입니다.

반환

리소스의 전역 ID인 ARM(Azure Resource Manager) ID입니다.

반환 형식

Optional[str]

inputs

파이프라인 작업의 입력입니다.

반환

파이프라인 작업의 입력입니다.

반환 형식

dict[str, Union[Input, str, bool, int, float]]

jobs

파이프라인 작업의 작업을 반환합니다.

반환

파이프라인 작업의 작업입니다.

반환 형식

dict

log_files

작업 출력 파일.

반환

로그 이름 및 URL의 사전입니다.

반환 형식

Optional[Dict[str, str]]

outputs

파이프라인 작업의 출력입니다.

반환

파이프라인 작업의 출력입니다.

반환 형식

dict[str, Union[str, Output]]

settings

파이프라인 작업의 설정입니다.

반환

파이프라인 작업의 설정입니다.

반환 형식

PipelineJobSettings

status

작업의 상태.

반환되는 일반적인 값에는 “Running”, “Completed”, “Failed”가 포함됩니다. 가능한 모든 값은 다음과 같습니다.

  • NotStarted - 클라우드 제출 전에 클라이언트 쪽 Run 개체가 있는 임시 상태입니다.

  • Starting - 실행이 클라우드에서 처리되기 시작했습니다. 호출자에게는 이 시점에서 실행 ID가 있습니다.

  • 프로비저닝 - 지정된 작업 제출을 위해 주문형 컴퓨팅을 만들고 있습니다.

  • 준비 중 - 실행 환경이 준비 중이며 다음 두 단계 중 하나입니다.

    • Docker 이미지 빌드

    • conda 환경 설정

  • 대기 중 - 작업이 컴퓨팅 대상에서 큐에 대기됩니다. 예를 들어 BatchAI에서 작업은 큐에 대기 상태입니다.

    요청된 모든 노드가 준비될 때까지 기다리는 동안 대기 상태입니다.

  • 실행 중 - 컴퓨팅 대상에서 작업이 실행되기 시작했습니다.

  • Finalizing - 사용자 코드 실행이 완료되었으며 실행이 사후 처리 단계에 있습니다.

  • CancelRequested - 작업에 대한 취소가 요청되었습니다.

  • 완료됨 - 실행이 성공적으로 완료되었습니다. 여기에는 사용자 코드 실행 및 실행이 모두 포함됩니다.

    사후 처리 단계입니다.

  • Failed - 실행이 실패했습니다. 일반적으로 실행의 오류 속성은 이유에 대한 세부 정보를 제공합니다.

  • Canceled - 취소 요청을 따르고 실행이 성공적으로 취소되었음을 나타냅니다.

  • NotResponding - 하트비트를 사용하도록 설정한 실행의 경우 최근에 하트비트를 보내지 않았습니다.

반환

작업의 상태.

반환 형식

Optional[str]

studio_url

Azure ML 스튜디오 엔드포인트.

반환

작업 세부 정보 페이지의 URL입니다.

반환 형식

Optional[str]

type

작업의 형식입니다.

반환

작업의 형식입니다.

반환 형식

Optional[str]