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)

僅限關鍵字的參數

名稱	Description
name	Optional[str] Command 作業或元件的名稱。
version	Optional[str] Command 作業或元件的版本。
description	Optional[str] 元件的描述。 預設值為 [無]。
tags	Optional[dict] 標記字典。 標記可以新增、移除和更新。 預設值為 [無]。
display_name	Optional[str] 元件的顯示名稱。
command	Optional[str] 要執行的命令。
code	要執行作業的原始程式碼。 可以是指向遠端位置的本機路徑或 「HTTP：」、「HTTPs：」或 「azureml：」 URL。
environment	Optional[Union[str, Environment]] 作業將執行的環境。
distribution	Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] 分散式作業的組態。 預設值為 [無]。
resources	Optional[JobResourceConfiguration] 命令的計算資源組態。
inputs	Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]] 輸入名稱與作業中使用的輸入資料來源對應。 預設值為 [無]。
outputs	Optional[dict[str, Union[str, Output]]] 輸出名稱與作業中使用的輸出資料來源對應。 預設值為 [無]。
instance_count	Optional[int] 計算目標要使用的實例或節點數目。 預設值為 1。
is_deterministic	Optional[bool] 指定命令是否會傳回相同輸入的相同輸出。 預設值為 True。 當為 True 時，如果命令 (元件) 具決定性，而且已在目前工作區中使用相同的輸入和設定執行，當做管線中的節點或步驟使用時，它會重複使用先前提交作業的結果。 在該案例中，不會使用任何計算資源。 預設值: True
additional_includes	Optional[List[str]] 要包含在元件中的共用其他檔案清單。 預設值為 [無]。
properties	Optional[dict[str, str]] 作業屬性字典。 預設值為 [無]。

範例

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

參數

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

資源識別碼。

傳回

類型	Description
Optional[str]	資源的全域識別碼，Azure Resource Manager (ARM) 識別碼。

inputs

元件的輸入。

傳回

類型	Description
dict	元件的輸入。

instance_count

計算目標要使用的實例或節點數目。

傳回

類型	Description
int	實例或節點的數目。

is_deterministic

元件是否具決定性。

傳回

類型	Description
bool	元件是否具決定性

outputs

元件的輸出。

傳回

類型	Description
dict	元件的輸出。

resources

命令元件或作業的計算資源組態。

傳回

類型	Description
JobResourceConfiguration	命令元件或作業的計算資源組態。

type

元件的類型，預設值為 'command'。

傳回

類型	Description
str	元件的類型。

version

元件的版本。

傳回

類型	Description
str	元件的版本。