Environment クラス

機械学習実験用の再現可能な Python 環境を構成します。

環境では、データ準備、トレーニング、Web サービスへのデプロイなど、機械学習実験で使用される Python パッケージ、環境変数、Docker 設定が定義されます。 環境は、Azure Machine Learning Workspace で管理され、バージョン管理されます。 既存の環境を更新し、再利用するバージョンを取得できます。 環境は、それらが作成されたワークスペースでのみ使用でき、別のワークスペースで使用することはできません。

環境の詳細については、再利用可能な環境の作成と管理に関するページを参照してください。

継承
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement
Environment

コンストラクター

Environment(name, **kwargs)

パラメーター

name
string
必須

環境の名前。

Note

"Microsoft" または "AzureML" を環境名の先頭に使用しないでください。 プレフィックス "Microsoft" と "AzureML" は、キュレーション環境用に予約されています。 キュレーション環境の詳細については、再利用可能な環境の作成と管理に関するページを参照してください。

注釈

Azure Machine Learning はキュレーションされた環境を提供します。これは、独自の環境を構築するための有効な開始点を提供する定義済みの環境です。 キュレーションされた環境は Docker イメージのキャッシュでバックアップされ、実行準備コストを減らします。 キュレーション環境の詳細については、再利用可能な環境の作成と管理に関するページを参照してください。

Azure Machine Learning では、次のような場合など、さまざまな方法で環境を作成できます。

次の例は、新しい環境をインスタンス化する方法を示しています。


   from azureml.core import Environment
   myenv = Environment(name="myenv")

環境は、登録することで管理できます。 これにより、環境のバージョンを追跡し、後で実行するときに再利用することができます。


   myenv.register(workspace=ws)

環境の使用に関するその他のサンプルについては、Jupyter Notebook の環境の使用に関するページを参照してください。

変数

Environment.databricks

このセクションでは、azureml.core.databricks.DatabricksSection ライブラリの依存関係を構成します。

docker
DockerSection

このセクションでは、環境の仕様に基づいて構築された最終的な Docker イメージに関連する設定と、Docker コンテナーを使用して環境を構築するかどうかを構成します。

inferencing_stack_version
string

このセクションでは、イメージに追加される推論スタックのバージョンを指定します。 推論スタックを追加しないようにするには、この値を設定しないでください。 有効な値: "latest"。

python
PythonSection

このセクションでは、ターゲットのコンピューティングで使用する Python 環境とインタープリターを指定します。

spark
SparkSection

セクションで Spark 設定が構成されます。 これは、フレームワークが PySpark に設定されている場合にのみ使用されます。

r
RSection

このセクションでは、ターゲットのコンピューティングで使用する R 環境を指定します。

version
string

環境のバージョン。

asset_id
string

資産 ID 環境が登録されたときに設定されます。

メソッド

add_private_pip_wheel

ディスク上のプライベート pip ホイール ファイルを、ワークスペースに接続されている Azure Storage BLOB にアップロードします。

ワークスペース ストレージ BLOB に同じ名前のプライベート pip ホイールが既に存在している場合は、例外がスローされます。

build

この環境の Docker イメージをクラウドに構築します。

build_local

ローカルの Docker または conda 環境をビルドします。

clone

環境オブジェクトを複製します。

新しい名前を使用して、環境オブジェクトの新しいインスタンスを返します。

from_conda_specification

環境仕様 YAML ファイルから環境オブジェクトを作成します。

環境仕様 YAML ファイルを取得するには、conda ユーザー ガイド環境の管理に関するページを参照してください。

from_docker_build_context

Docker ビルド コンテキストから環境オブジェクトを作成します。

from_docker_image

省略可能な python 依存関係を使用して、基本 docker イメージから環境オブジェクトを作成します。

conda_specification または pip_requirements が指定されている場合、Python レイヤーが環境に追加されます。 conda_specification と pip_requirements は相互に排他的です。

from_dockerfile

オプションの Python 依存を使用して Dockerfile から環境オブジェクトを作成します。

conda_specification または pip_requirements が指定されている場合、Python レイヤーが環境に追加されます。 conda_specification と pip_requirements は相互に排他的です。

from_existing_conda_environment

ローカルの既存の conda 環境から作成された環境オブジェクトを作成します。

既存の conda 環境の一覧を取得するには、conda env list を実行します。 詳細については、conda ユーザーガイドの環境の管理に関するページを参照してください。

from_pip_requirements

pip 要件ファイルから作成された環境オブジェクトを作成します。

pip_version が指定されていない場合、固定されていない pip 依存関係が追加されます。

get

環境オブジェクトを返します。

ラベルが指定されている場合、以前に値がラベル付けされたオブジェクトが返されます。 1 つのバージョンまたはラベル パラメーターのみを指定できます。 どちらもない場合は、環境オブジェクトの最後のバージョンが返されます。

get_image_details

イメージの詳細を返します。

label

指定された値を使用して、ワークスペースの環境オブジェクトにラベルを付けます。

list

ワークスペース内の環境を含む辞書を返します。

load_from_directory

ディレクトリ内のファイルから環境定義を読み込みます。

register

ワークスペース内の環境オブジェクトを登録します。

save_to_directory

環境定義を簡単に編集できる形式でディレクトリに保存します。

add_private_pip_wheel

ディスク上のプライベート pip ホイール ファイルを、ワークスペースに接続されている Azure Storage BLOB にアップロードします。

ワークスペース ストレージ BLOB に同じ名前のプライベート pip ホイールが既に存在している場合は、例外がスローされます。

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

パラメーター

workspace
Workspace
必須

プライベート pip ホイールを登録するために使用するワークスペース オブジェクト。

file_path
str
必須

ファイル拡張子を含む、ディスク上のローカル pip ホイールへのパス。

exist_ok
bool
既定値: False

ホイールが既に存在する場合に例外をスローするかどうかを示します。

戻り値

Conda 依存関係で使用するために、Azure BLOB ストレージでアップロードされた pip ホイールの完全な URI を返します。

の戻り値の型 :

str

build

この環境の Docker イメージをクラウドに構築します。

build(workspace, image_build_compute=None)

パラメーター

workspace
Workspace
必須

イメージが格納されているワークスペースとそれに関連付けられている Azure Container Registry。

image_build_compute
str
既定値: None

イメージのビルドが行われるコンピューティング名

戻り値

イメージ ビルドの詳細オブジェクトを返します。

の戻り値の型 :

build_local

ローカルの Docker または conda 環境をビルドします。

build_local(workspace, platform=None, **kwargs)

パラメーター

workspace
Workspace
必須

ワークスペース。

platform
str
既定値: None

[プラットフォーム]: LinuxWindows、または OSX のいずれか。 既定では、現在のプラットフォームが使用されます。

kwargs
dict
必須

高度なキーワード引数

戻り値

進行中の Docker または conda のビルドの出力をコンソールにストリーミングします。

の戻り値の型 :

str

注釈

次の例は、ローカル環境を構築する方法を示しています。 ワークスペースが有効な azureml.core.workspace ワークスペース オブジェクトとしてインスタンス化されていることを確認してください

ローカル conda 環境をビルドします


   from azureml.core import Environment
   myenv = Environment(name="myenv")
   registered_env = myenv.register(workspace)
   registered_env.build_local(workspace)

ローカル Docker 環境をビルドします


   from azureml.core import Environment
   myenv = Environment(name="myenv")
   registered_env = myenv.register(workspace)
   registered_env.build_local(workspace, useDocker=True)

Docker イメージをローカルにビルドし、必要に応じて、ワークスペースに関連付けられているコンテナー レジストリにプッシュします。


   from azureml.core import Environment
   myenv = Environment(name="myenv")
   registered_env = myenv.register(workspace)
   registered_env.build_local(workspace, useDocker=True, pushImageToWorkspaceAcr=True)

clone

環境オブジェクトを複製します。

新しい名前を使用して、環境オブジェクトの新しいインスタンスを返します。

clone(new_name)

パラメーター

new_name
str
必須

新しい環境名

戻り値

新しい環境オブジェクト

の戻り値の型 :

from_conda_specification

環境仕様 YAML ファイルから環境オブジェクトを作成します。

環境仕様 YAML ファイルを取得するには、conda ユーザー ガイド環境の管理に関するページを参照してください。

static from_conda_specification(name, file_path)

パラメーター

name
str
必須

環境名。

file_path
str
必須

Conda 環境仕様の YAML ファイル パス。

戻り値

環境オブジェクト。

の戻り値の型 :

from_docker_build_context

Docker ビルド コンテキストから環境オブジェクトを作成します。

static from_docker_build_context(name, docker_build_context)

パラメーター

name
str
必須

環境名。

docker_build_context
DockerBuildContext
必須

DockerBuildContext オブジェクト。

戻り値

環境オブジェクト。

の戻り値の型 :

from_docker_image

省略可能な python 依存関係を使用して、基本 docker イメージから環境オブジェクトを作成します。

conda_specification または pip_requirements が指定されている場合、Python レイヤーが環境に追加されます。 conda_specification と pip_requirements は相互に排他的です。

static from_docker_image(name, image, container_registry=None, conda_specification=None, pip_requirements=None)

パラメーター

name
str
必須

環境名。

image
str
必須

イメージの完全修飾名

conda_specification
str
既定値: None

conda 仕様ファイル。

container_registry
ContainerRegistry
既定値: None

プライベート コンテナー リポジトリの詳細。

pip_requirements
str
既定値: None

pip 要件ファイル

戻り値

環境オブジェクト。

の戻り値の型 :

注釈

基本イメージが承認を必要とするプライベート リポジトリからのものであり、AzureML ワークスペース レベルで承認が設定されていない場合は、container_registry が必要です。

from_dockerfile

オプションの Python 依存を使用して Dockerfile から環境オブジェクトを作成します。

conda_specification または pip_requirements が指定されている場合、Python レイヤーが環境に追加されます。 conda_specification と pip_requirements は相互に排他的です。

static from_dockerfile(name, dockerfile, conda_specification=None, pip_requirements=None)

パラメーター

name
str
必須

環境名。

dockerfile
str
必須

Dockerfile のコンテンツまたはファイルへのパス。

conda_specification
str
既定値: None

conda 仕様ファイル。

pip_requirements
str
既定値: None

pip 要件ファイル

戻り値

環境オブジェクト。

の戻り値の型 :

from_existing_conda_environment

ローカルの既存の conda 環境から作成された環境オブジェクトを作成します。

既存の conda 環境の一覧を取得するには、conda env list を実行します。 詳細については、conda ユーザーガイドの環境の管理に関するページを参照してください。

static from_existing_conda_environment(name, conda_environment_name)

パラメーター

name
str
必須

環境名。

conda_environment_name
str
必須

ローカルの既存の conda 環境の名前。

戻り値

環境オブジェクト、または conda 仕様ファイルのエクスポートが失敗した場合は None。

の戻り値の型 :

from_pip_requirements

pip 要件ファイルから作成された環境オブジェクトを作成します。

pip_version が指定されていない場合、固定されていない pip 依存関係が追加されます。

static from_pip_requirements(name, file_path, pip_version=None)

パラメーター

name
str
必須

環境名。

file_path
str
必須

pip 要件ファイルのパス。

pip_version
str
既定値: None

conda 環境の pip バージョン。

戻り値

環境オブジェクト。

の戻り値の型 :

get

環境オブジェクトを返します。

ラベルが指定されている場合、以前に値がラベル付けされたオブジェクトが返されます。 1 つのバージョンまたはラベル パラメーターのみを指定できます。 どちらもない場合は、環境オブジェクトの最後のバージョンが返されます。

static get(workspace, name, version=None, label=None)

パラメーター

workspace
Workspace
必須

環境を含むワークスペース。

name
str
必須

返される環境の名前。

version
str
既定値: None

返される環境のバージョン。

label
str
既定値: None

環境ラベル値。

戻り値

環境オブジェクト。

の戻り値の型 :

get_image_details

イメージの詳細を返します。

get_image_details(workspace)

パラメーター

workspace
Workspace
必須

ワークスペース。

戻り値

イメージの詳細を dict として返します。

の戻り値の型 :

label

指定された値を使用して、ワークスペースの環境オブジェクトにラベルを付けます。

static label(workspace, name, version, labels)

パラメーター

workspace
Workspace
必須

ワークスペース

name
str
必須

環境名

version
str
必須

環境のバージョン

labels
list[str]
必須

環境にラベルを付けるために使用する値

list

ワークスペース内の環境を含む辞書を返します。

static list(workspace)

パラメーター

workspace
Workspace
必須

環境を一覧表示する元になるワークスペース。

戻り値

環境オブジェクトの辞書。

の戻り値の型 :

<xref:builtin.dict>[str, Environment]

load_from_directory

ディレクトリ内のファイルから環境定義を読み込みます。

static load_from_directory(path)

パラメーター

path
str
必須

ソース ディレクトリのパス。

register

ワークスペース内の環境オブジェクトを登録します。

register(workspace)

パラメーター

workspace
Workspace
必須

ワークスペース

name
str
必須

戻り値

環境オブジェクトを返します。

の戻り値の型 :

save_to_directory

環境定義を簡単に編集できる形式でディレクトリに保存します。

save_to_directory(path, overwrite=False)

パラメーター

path
str
必須

宛先ディレクトリへのパス。

overwrite
bool
既定値: False

既存のディレクトリを上書きする必要があるかどうか。 既定値は false です。

属性

environment_variables

ランタイム変数を設定するには、azureml.core.RunConfiguration オブジェクトを使用します。