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

パラメーター

名前	説明
dest 必須	Union[<xref:PathLike>, str, IO[AnyStr]] このコンポーネントのコンテンツを受信する宛先。ローカルファイルへのパス、または既に開いているファイルストリームである必要があります。 dest がファイルパスの場合は、新しいファイルが作成され、ファイルが存在する場合は例外が発生します。 dest が開いているファイルの場合、ファイルはに直接書き込まれ、ファイルが書き込み可能でない場合は例外が発生します。

名前

説明

dest

必須

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

このコンポーネントのコンテンツを受信する宛先。ローカルファイルへのパス、または既に開いているファイルストリームである必要があります。 dest がファイルパスの場合は、新しいファイルが作成され、ファイルが存在する場合は例外が発生します。 dest が開いているファイルの場合、ファイルはに直接書き込まれ、ファイルが書き込み可能でない場合は例外が発生します。

属性

base_path

リソースのベースパス。

戻り値

型	説明
str	リソースのベースパス。

creation_context

リソースの作成コンテキスト。

戻り値

型	説明
Optional[SystemData]	リソースの作成メタデータ。

display_name

コンポーネントの表示名。

戻り値

型	説明
str	コンポーネントの表示名。

distribution

分散コマンドコンポーネントまたはジョブの構成。

戻り値

型	説明
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]	ディストリビューションの構成。

id

リソース ID。

戻り値

型	説明
Optional[str]	リソースのグローバル ID、Azure Resource Manager (ARM) ID。

inputs

コンポーネントの入力。

戻り値

型	説明
dict	コンポーネントの入力。

instance_count

コンピューティング先で使用されるインスタンスまたはノードの数。

戻り値

型	説明
int	インスタンスまたはノードの数。

is_deterministic

コンポーネントが決定的かどうか。

戻り値

型	説明
bool	コンポーネントが決定的かどうか

outputs

コンポーネントの出力。

戻り値

型	説明
dict	コンポーネントの出力。

resources

コマンドコンポーネントまたはジョブのコンピューティングリソース構成。

戻り値

型	説明
JobResourceConfiguration	コマンドコンポーネントまたはジョブのコンピューティングリソース構成。

type

コンポーネントの種類。既定値は 'command' です。

戻り値

型	説明
str	コンポーネントの種類。

version

コンポーネントのバージョン。

戻り値

型	説明
str	コンポーネントのバージョン。