Component クラス

  • リファレンス

コンポーネント バージョンの基本クラス。コンポーネントの定義に使用されます。 直接インスタンス化することはできません。

継承
azure.ai.ml.entities._assets.asset.Asset
Component
azure.ai.ml.entities._validation.remote.RemoteValidatableMixin
Component
azure.ai.ml.entities._mixins.TelemetryMixin
Component
azure.ai.ml.entities._mixins.YamlTranslatableMixin
Component
azure.ai.ml.entities._validation.path_aware_schema.PathAwareSchemaValidatableMixin
Component
azure.ai.ml.entities._mixins.LocalizableMixin
Component

コンストラクター

Component(*, name: str | None = None, version: str | None = None, id: str | None = None, type: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, display_name: str | None = None, is_deterministic: bool = True, inputs: Dict | None = None, outputs: Dict | None = None, yaml_str: str | None = None, _schema: str | None = None, creation_context: SystemData | None = None, **kwargs: Any)

パラメーター

名前 説明
name
必須
str

リソースの名前。
version
必須
str

リソースのバージョン。
id
必須
str

リソースのグローバル ID、Azure Resource Manager ID。
type
必須
str

サポートされているコマンドの種類は 'command' です。
description
必須
str

リソースの説明。
tags
必須
dict

タグ辞書。 タグは追加、削除、更新できます。
properties
必須
dict

内部使用のみです。
display_name
必須
str

コンポーネントの表示名。
is_deterministic
必須
bool

コンポーネントが決定論的かどうか。 既定値は True です。
inputs
必須
dict

コンポーネントの入力。
outputs
必須
dict

コンポーネントの出力。
yaml_str
必須
str

コンポーネントの YAML 文字列。
_schema
必須
str

コンポーネントのスキーマ。
creation_context
必須
SystemData

コンポーネントの作成メタデータ。
kwargs
必須

コンポーネントの追加パラメーター。

Keyword-Only パラメータ

名前 説明
name
必須
version
必須
id
必須
type
必須
description
必須
tags
必須
properties
必須
display_name
必須
is_deterministic
既定値: True
inputs
必須
outputs
必須
yaml_str
必須
_schema
必須
creation_context
必須

メソッド

dump

コンポーネントの内容を yaml 形式のファイルにダンプします。

dump

コンポーネントの内容を yaml 形式のファイルにダンプします。

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

パラメーター

名前 説明
dest
必須
Union[<xref:PathLike>, str, IO[AnyStr]]

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

属性

base_path

リソースのベース パス。

戻り値

型 説明
str

リソースのベース パス。

creation_context

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

戻り値

型 説明
Optional[SystemData]

リソースの作成メタデータ。

display_name

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

戻り値

型 説明
str

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

id

リソース ID。

戻り値

型 説明
Optional[str]

リソースのグローバル ID、Azure Resource Manager (ARM) ID。

inputs

コンポーネントの入力。

戻り値

型 説明
dict

コンポーネントの入力。

is_deterministic

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

戻り値

型 説明
bool

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

outputs

コンポーネントの出力。

戻り値

型 説明
dict

コンポーネントの出力。

type

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

戻り値

型 説明
str

コンポーネントの種類。

version

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

戻り値

型 説明
str

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