CommandComponent 클래스

참조

명령 구성 요소 또는 작업을 정의하는 데 사용되는 명령 구성 요소 버전입니다.

상속: azure.ai.ml.entities._component.component.Component

CommandComponent

azure.ai.ml.entities._job.parameterized_command.ParameterizedCommand

CommandComponent

azure.ai.ml.entities._component._additional_includes.AdditionalIncludesMixin

CommandComponent

생성자

CommandComponent(*, name: str | None = None, version: str | None = None, description: str | None = None, tags: Dict | None = None, display_name: str | None = None, command: str | None = None, code: PathLike | str | None = None, environment: Environment | str | None = None, distribution: Dict | MpiDistribution | TensorFlowDistribution | PyTorchDistribution | RayDistribution | DistributionConfiguration | None = None, resources: JobResourceConfiguration | None = None, inputs: Dict | None = None, outputs: Dict | None = None, instance_count: int | None = None, is_deterministic: bool = True, additional_includes: List | None = None, properties: Dict | None = None, **kwargs: Any)

키워드 전용 매개 변수

Name	Description
name	Optional[str] 명령 작업 또는 구성 요소의 이름입니다.
version	Optional[str] 명령 작업 또는 구성 요소의 버전입니다.
description	Optional[str] 구성 요소에 대한 설명입니다. 기본값은 None입니다.
tags	Optional[dict] 태그 사전. 태그를 추가, 제거 및 업데이트할 수 있습니다. 기본값은 None입니다.
display_name	Optional[str] 구성 요소의 표시 이름입니다.
command	Optional[str] 실행할 명령입니다.
code	작업을 실행할 소스 코드입니다. 원격 위치를 가리키는 로컬 경로 또는 "http:", "https:"또는 "azureml:" URL일 수 있습니다.
environment	Optional[Union[str, Environment]] 작업이 실행될 환경입니다.
distribution	Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] 분산 작업에 대한 구성입니다. 기본값은 None입니다.
resources	Optional[JobResourceConfiguration] 명령에 대한 컴퓨팅 리소스 구성입니다.
inputs	Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]] 입력 이름을 작업에 사용되는 입력 데이터 원본에 매핑합니다. 기본값은 None입니다.
outputs	Optional[dict[str, Union[str, Output]]] 작업에 사용되는 출력 데이터 원본에 대한 출력 이름의 매핑입니다. 기본값은 None입니다.
instance_count	Optional[int] 컴퓨팅 대상에서 사용할 인스턴스 또는 노드 수입니다. 기본값은 1입니다.
is_deterministic	Optional[bool] 명령이 동일한 입력을 감안할 때 동일한 출력을 반환할지 여부를 지정합니다. 기본값은 True입니다. True이면 명령(구성 요소)이 결정적이며 동일한 입력 및 설정을 사용하여 현재 작업 영역에서 이전에 실행된 경우 파이프라인의 노드 또는 단계로 사용할 때 이전에 제출된 작업의 결과를 다시 사용합니다. 이 시나리오에서는 컴퓨팅 리소스가 사용되지 않습니다. 기본값: True
additional_includes	Optional[List[str]] 구성 요소에 포함할 공유 추가 파일 목록입니다. 기본값은 None입니다.
properties	Optional[dict[str, str]] 작업 속성 사전입니다. 기본값은 None입니다.

예제

CommandComponent를 만듭니다.


   from azure.ai.ml.entities import CommandComponent

   component = CommandComponent(
       name="sample_command_component_basic",
       display_name="CommandComponentBasic",
       description="This is the basic command component",
       tags={"tag": "tagvalue", "owner": "sdkteam"},
       version="1",
       outputs={"component_out_path": {"type": "uri_folder"}},
       command="echo Hello World",
       code="./src",
       environment="AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33",
   )

메서드

dump	구성 요소 콘텐츠를 yaml 형식의 파일로 덤프합니다.

dump

구성 요소 콘텐츠를 yaml 형식의 파일로 덤프합니다.

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

매개 변수

Name	Description
dest 필수	Union[<xref:PathLike>, str, IO[AnyStr]] 이 구성 요소의 콘텐츠를 받을 대상입니다. 로컬 파일의 경로이거나 이미 열려 있는 파일 스트림이어야 합니다. dest가 파일 경로인 경우 새 파일이 만들어지고 파일이 있는 경우 예외가 발생합니다. dest가 열려 있는 파일인 경우 파일이 직접 기록되고 파일을 쓸 수 없는 경우 예외가 발생합니다.

Name

Description

dest

필수

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

이 구성 요소의 콘텐츠를 받을 대상입니다. 로컬 파일의 경로이거나 이미 열려 있는 파일 스트림이어야 합니다. dest가 파일 경로인 경우 새 파일이 만들어지고 파일이 있는 경우 예외가 발생합니다. dest가 열려 있는 파일인 경우 파일이 직접 기록되고 파일을 쓸 수 없는 경우 예외가 발생합니다.

특성

base_path

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

반환

형식	Description
str	리소스의 기본 경로입니다.

creation_context

리소스의 생성 컨텍스트입니다.

반환

형식	Description
Optional[SystemData]	리소스에 대한 만들기 메타데이터입니다.

display_name

구성 요소의 표시 이름입니다.

반환

형식	Description
str	구성 요소의 표시 이름입니다.

distribution

분산 명령 구성 요소 또는 작업에 대한 구성입니다.

반환

형식	Description
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]	배포 구성입니다.

id

리소스 ID입니다.

반환

형식	Description
Optional[str]	리소스의 전역 ID인 ARM(Azure Resource Manager) ID입니다.

inputs

구성 요소의 입력입니다.

반환

형식	Description
dict	구성 요소의 입력입니다.

instance_count

컴퓨팅 대상에서 사용할 인스턴스 또는 노드 수입니다.

반환

형식	Description
int	인스턴스 또는 노드 수입니다.

is_deterministic

구성 요소가 결정적인지 여부입니다.

반환

형식	Description
bool	구성 요소가 결정적인지 여부

outputs

구성 요소의 출력입니다.

반환

형식	Description
dict	구성 요소의 출력입니다.

resources

명령 구성 요소 또는 작업에 대한 컴퓨팅 리소스 구성입니다.

반환

형식	Description
JobResourceConfiguration	명령 구성 요소 또는 작업에 대한 컴퓨팅 리소스 구성입니다.

type

구성 요소의 유형입니다. 기본값은 'command'입니다.

반환

형식	Description
str	구성 요소의 형식입니다.

version

구성 요소 버전입니다.

반환

형식	Description
str	구성 요소 버전입니다.

Share via