EnvironmentOperations クラス

EnvironmentOperations。

このクラスを直接インスタンス化しないでください。 代わりに、インスタンス化して属性としてアタッチする MLClient インスタンスを作成する必要があります。

継承
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
EnvironmentOperations

コンストラクター

EnvironmentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, all_operations: OperationsContainer, **kwargs: Any)

パラメーター

operation_scope
<xref:azure.ai.ml._scope_dependent_operations.OperationScope>
必須

MLClient オブジェクトの操作クラスのスコープ変数。

operation_config
<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>
必須

MLClient オブジェクトの操作クラスの一般的な構成。

service_client
Union[ <xref:azure.ai.ml._restclient.v2023_04_01_preview._azure_machine_learning_workspaces.AzureMachineLearningWorkspaces>, <xref:azure.ai.ml._restclient.v2021_10_01_dataplanepreview._azure_machine_learning_workspaces. AzureMachineLearningWorkspaces>]
必須

エンド ユーザーが Azure Machine Learning ワークスペース リソース (ServiceClient042023Preview または ServiceClient102021Dataplane) を操作できるようにするサービス クライアント。

all_operations
<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>
必須

MLClient オブジェクトのすべての操作クラス。

メソッド

archive

環境または環境バージョンをアーカイブします。

create_or_update

作成または更新された環境資産を返します。

get

指定した環境資産を返します。

list

ワークスペース内のすべての環境資産を一覧表示します。

restore

アーカイブされた環境のバージョンを復元します。

share

Note

これは試験的なメソッドであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。

ワークスペースからレジストリに環境資産を共有します。

archive

環境または環境バージョンをアーカイブします。

archive(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

パラメーター

name
str
必須

環境の名前。

version
str
必須

環境のバージョン。

label
str
必須

環境のラベル。 (バージョンと相互に排他的)

アーカイブの例。


   ml_client.environments.archive("create-environment", "2.0")

create_or_update

作成または更新された環境資産を返します。

create_or_update(environment: Environment) -> Environment

パラメーター

environment
<xref:azure.ai.ml.entities._assets.Environment>
必須

環境オブジェクト

戻り値

Environment オブジェクトを作成または更新しました

の戻り値の型 :

例外

環境を正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。

指定されたローカル パスが空のディレクトリを指している場合に発生します。

環境を作成します。


   from azure.ai.ml.entities import BuildContext, Environment

   env_docker_context = Environment(
       build=BuildContext(
           path="./sdk/ml/azure-ai-ml/tests/test_configs/environment/environment_files",
           dockerfile_path="DockerfileNonDefault",
       ),
       name="create-environment",
       version="2.0",
       description="Environment created from a Docker context.",
   )
   ml_client.environments.create_or_update(env_docker_context)

get

指定した環境資産を返します。

get(name: str, version: str | None = None, label: str | None = None) -> Environment

パラメーター

name
str
必須

環境の名前。

version
str
必須

環境のバージョン。

label
str
必須

環境のラベル。 (バージョンと相互に排他的)

戻り値

環境オブジェクト

の戻り値の型 :

例外

環境を正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。

例を取得します。


   ml_client.environments.get("create-environment", "2.0")

list

ワークスペース内のすべての環境資産を一覧表示します。

list(name: str | None = None, *, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY) -> Iterable[Environment]

パラメーター

name
Optional[str]
必須

環境の名前。

list_view_type

アーカイブされた環境を含める/除外する (たとえば) の種類を表示します。 既定値: ACTIVE_ONLY。

戻り値

Environment オブジェクトのインスタンスのような反復子。

の戻り値の型 :

リストの例。


   ml_client.environments.list()

restore

アーカイブされた環境のバージョンを復元します。

restore(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

パラメーター

name
str
必須

環境の名前。

version
str
必須

環境のバージョン。

label
str
必須

環境のラベル。 (バージョンと相互に排他的)

復元の例。


   ml_client.environments.restore("create-environment", "2.0")

share

Note

これは試験的なメソッドであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。

ワークスペースからレジストリに環境資産を共有します。

share(name: str, version: str, *, share_with_name: str, share_with_version: str, registry_name: str) -> Environment

パラメーター

name
str
必須

環境資産の名前。

version
str
必須

環境資産のバージョン。

share_with_name
str

共有する環境資産の名前。

share_with_version
str

共有する環境資産のバージョン。

registry_name
str

移行先レジストリの名前。

戻り値

環境アセット オブジェクト。

の戻り値の型 :