Environment クラス

  • リファレンス

トレーニング用の環境。

継承
azure.ai.ml.entities._assets.asset.Asset
Environment
azure.ai.ml.entities._mixins.LocalizableMixin
Environment

コンストラクター

Environment(*, name: str | None = None, version: str | None = None, description: str | None = None, image: str | None = None, build: BuildContext | None = None, conda_file: str | PathLike | None = None, tags: Dict | None = None, properties: Dict | None = None, datastore: str | None = None, **kwargs)

パラメーター

name
str
必須

リソースの名前。

version
str
必須

資産のバージョン。

description
str
必須

リソースの説明。

image
str
必須

カスタム基本イメージの URI。

build
BuildContext
必須

環境を作成するための Docker ビルド コンテキスト。 "image" と相互に排他的

conda_file
Union[str, PathLike]
必須

インストールする conda パッケージを一覧表示する構成ファイルへのパス。

tags
dict[str, str]
必須

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

properties
dict[str, str]
必須

資産プロパティ ディクショナリ。

datastore
str
必須

ローカル成果物をアップロードするデータストア。

kwargs
dict
必須

追加の構成パラメーターのディクショナリ。

例

Environment オブジェクトを作成します。


   from azure.ai.ml.entities._assets.environment import Environment

   environment = Environment(
       name="env-name",
       version="2.0",
       description="env-description",
       image="env-image",
       conda_file="./sdk/ml/azure-ai-ml/tests/test_configs/deployments/model-1/environment/conda.yml",
       tags={"tag1": "value1", "tag2": "value2"},
       properties={"prop1": "value1", "prop2": "value2"},
       datastore="datastore",
   )

メソッド

dump

アセットの内容を YAML 形式のファイルにダンプします。
validate

名前、イメージ、ビルドを確認して環境を検証する

dump

アセットの内容を YAML 形式のファイルにダンプします。

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

パラメーター

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

YAML コンテンツを書き込むローカル パスまたはファイル ストリーム。 dest がファイル パスの場合は、新しいファイルが作成されます。 dest が開いているファイルの場合、ファイルは に直接書き込まれます。

kwargs
dict

YAML シリアライザーに渡す追加の引数。

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

validate

名前、イメージ、ビルドを確認して環境を検証する

validate()

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

例

環境の検証の例。


   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.",
   )

   env_docker_context.validate()

属性

base_path

リソースのベース パス。

戻り値

リソースのベース パス。

の戻り値の型 :

str

conda_file

Conda 環境の仕様。

戻り値

パラメーターから読み込まれた Conda 依存関係conda_file 。

の戻り値の型 :

Dict

creation_context

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

戻り値

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

の戻り値の型 :

Optional[SystemData]

id

リソース ID。

戻り値

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

の戻り値の型 :

Optional[str]

version

資産のバージョン。

戻り値

資産のバージョン。

の戻り値の型 :

str