ComponentOperations クラス
ComponentOperations。
このクラスを直接インスタンス化しないでください。 代わりに、インスタンス化して属性としてアタッチする MLClient インスタンスを作成する必要があります。
- 継承
-
azure.ai.ml._scope_dependent_operations._ScopeDependentOperationsComponentOperations
コンストラクター
ComponentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, all_operations: OperationsContainer, preflight_operation: DeploymentsOperations | None = None, **kwargs: Dict)
パラメーター
- operation_scope
- <xref:azure.ai.ml._scope_dependent_operations.OperationScope>
操作スコープ。
- operation_config
- <xref:azure.ai.ml._scope_dependent_operations.OperationConfig>
操作の構成。
- service_client
- Union[ <xref:azure.ai.ml._restclient.v2022_10_01.AzureMachineLearningWorkspaces>, <xref:azure.ai.ml._restclient.v2021_10_01_dataplanepreview.AzureMachineLearningWorkspaces>]
API 操作用のサービス クライアント。
- all_operations
- <xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>
使用可能なすべての操作のコンテナー。
- preflight_operation
- Optional[<xref:azure.ai.ml._vendor.azure_resources.operations.DeploymentsOperations>]
デプロイのプレフライト操作。
メソッド
archive |
コンポーネントをアーカイブします。 |
create_or_update |
指定したコンポーネントを作成または更新します。 インラインで定義されたエンティティ (環境、コードなど) がある場合は、 コンポーネントと共に作成されます。 |
download |
Note これは試験的なメソッドであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。 指定したコンポーネントとその依存関係をローカルにダウンロードします。 ローカル コンポーネントを使用して、別のワークスペースまたはオフライン開発用にコンポーネントを作成できます。 |
get |
指定したコンポーネントに関する情報を返します。 |
list |
ワークスペースの特定のコンポーネントを一覧表示します。 |
restore |
アーカイブされたコンポーネントを復元します。 |
validate |
Note これは試験的なメソッドであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。 指定したコンポーネントを検証します。 インラインで定義されたエンティティ (環境、コードなど) がある場合、それらは作成されません。 |
archive
コンポーネントをアーカイブします。
archive(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None
パラメーター
例
アーカイブ コンポーネントの例。
ml_client.components.archive(name=component_example.name)
create_or_update
指定したコンポーネントを作成または更新します。 インラインで定義されたエンティティ (環境、コードなど) がある場合は、 コンポーネントと共に作成されます。
create_or_update(component: Component | function, version=None, *, skip_validation: bool = False, **kwargs) -> Component
パラメーター
- component
- Union[Component, FunctionType]
コンポーネント オブジェクトまたはコンポーネント オブジェクトを生成する mldesigner コンポーネント関数
- skip_validation
- bool
コンポーネントを作成または更新する前に検証をスキップするかどうかを指定します。既定値は False です
戻り値
指定したコンポーネント オブジェクト。
の戻り値の型 :
例外
コンポーネントを正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。
コンポーネント資産 (データ、コード、モデル、環境など) が正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。
コンポーネントの種類がサポートされていない場合に発生します。 詳細はエラー メッセージに表示されます。
コンポーネント モデルを正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。
指定されたローカル パスが空のディレクトリを指している場合に発生します。
例
コンポーネントの作成の例。
from azure.ai.ml import load_component
from azure.ai.ml.entities._component.component import Component
component_example = load_component(
source="./sdk/ml/azure-ai-ml/tests/test_configs/components/helloworld_component.yml",
params_override=[{"version": "1.0.2"}],
)
component = ml_client.components.create_or_update(component_example)
download
Note
これは試験的なメソッドであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。
指定したコンポーネントとその依存関係をローカルにダウンロードします。 ローカル コンポーネントを使用して、別のワークスペースまたはオフライン開発用にコンポーネントを作成できます。
download(name: str, download_path: PathLike | str = '.', *, version: str = None) -> None
パラメーター
戻り値
指定したコンポーネント オブジェクト。
の戻り値の型 :
例外
download_pathが空ではない既存のディレクトリを指している場合に発生します。 識別され、取得されます。 詳細はエラー メッセージに表示されます。
get
指定したコンポーネントに関する情報を返します。
get(name: str, version: str | None = None, label: str | None = None) -> Component
パラメーター
戻り値
指定したコンポーネント オブジェクト。
の戻り値の型 :
例外
コンポーネントを正常に識別して取得できない場合に発生します。 詳細はエラー メッセージに表示されます。
例
コンポーネントの取得の例。
ml_client.components.get(name=component_example.name, version="1.0.2")
list
ワークスペースの特定のコンポーネントを一覧表示します。
list(name: str | None = None, *, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY) -> Iterable[Component]
パラメーター
- list_view_type
アーカイブ済みコンポーネントを含める/除外する (たとえば) 種類を表示します。 既定値: ACTIVE_ONLY。
戻り値
コンポーネント オブジェクトのインスタンスのような反復子
の戻り値の型 :
例
リスト コンポーネントの例。
print(ml_client.components.list())
restore
アーカイブされたコンポーネントを復元します。
restore(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None
パラメーター
例
復元コンポーネントの例。
ml_client.components.restore(name=component_example.name)
validate
Note
これは試験的なメソッドであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。
指定したコンポーネントを検証します。 インラインで定義されたエンティティ (環境、コードなど) がある場合、それらは作成されません。
validate(component: Component | function, raise_on_failure: bool = False, **kwargs) -> ValidationResult
パラメーター
- component
- Union[Component, FunctionType]
コンポーネント オブジェクトまたはコンポーネント オブジェクトを生成する mldesigner コンポーネント関数
戻り値
すべての検証エラー
の戻り値の型 :
Azure SDK for Python