次の方法で共有

Environment クラス

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

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

環境の詳細については、「 再利用可能な環境の作成と管理」を参照してください。

クラス環境コンストラクター。

コンストラクター

Environment(name, **kwargs)

パラメーター

名前 説明
name
必須
string

環境の名前。

注

"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 Using environments」を参照してください。

変数

名前 説明
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 wheel ファイルを、ワークスペースに接続されている 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 依存関係は、 pip_version が指定されていない場合に追加されます。
get

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

ラベルが指定されている場合は、以前に値でラベル付けされたオブジェクトが返されます。 指定できるバージョンまたはラベル パラメーターは 1 つだけです。 両方が見当たっていない場合は、Environment オブジェクトの最新バージョンが返されます。
get_image_details

画像の詳細を返します。
label

ワークスペース内の環境オブジェクトに、指定した値でラベルを付けます。
list

ワークスペース内の環境を含むディクショナリを返します。
load_from_directory

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

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

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

add_private_pip_wheel

ディスク上のプライベート pip wheel ファイルを、ワークスペースに接続されている 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

戻り値

型 説明
str

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

build

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

build(workspace, image_build_compute=None)

パラメーター

名前 説明
workspace
必須
Workspace

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

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

規定値: None

戻り値

型 説明
ImageBuildDetails

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

build_local

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

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

パラメーター

名前 説明
workspace
必須
Workspace

ワークスペース。
platform
str

プラットホーム。 Linux、Windows、OSX のいずれか。 現在のプラットフォームは既定で使用されます。

規定値: None
kwargs
必須
dict

高度なキーワード引数

戻り値

型 説明
str

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

注釈

次の例は、ローカル環境を構築する方法を示しています。 ワークスペースが有効な azureml.core.workspace.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

新しい環境名

戻り値

型 説明
Environment

新しい環境オブジェクト

from_conda_specification

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

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

static from_conda_specification(name, file_path)

パラメーター

名前 説明
name
必須
str

環境名。
file_path
必須
str

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

戻り値

型 説明
Environment

環境オブジェクト。

from_docker_build_context

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

static from_docker_build_context(name, docker_build_context)

パラメーター

名前 説明
name
必須
str

環境名。
docker_build_context
必須
DockerBuildContext

DockerBuildContext オブジェクト。

戻り値

型 説明
Environment

環境オブジェクト。

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

conda 仕様ファイル。

規定値: None
container_registry
ContainerRegistry

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

規定値: None
pip_requirements
str

pip 要件ファイル。

規定値: None

戻り値

型 説明
Environment

環境オブジェクト。

注釈

基本イメージが承認を必要とするプライベート リポジトリからのものであり、承認が 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

conda 仕様ファイル。

規定値: None
pip_requirements
str

pip 要件ファイル。

規定値: None

戻り値

型 説明
Environment

環境オブジェクト。

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 環境の名前。

戻り値

型 説明
Environment

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

from_pip_requirements

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

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

static from_pip_requirements(name, file_path, pip_version=None)

パラメーター

名前 説明
name
必須
str

環境名。
file_path
必須
str

pip 要件のファイル パス。
pip_version
str

conda 環境の Pip バージョン。

規定値: None

戻り値

型 説明
Environment

環境オブジェクト。

get

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

ラベルが指定されている場合は、以前に値でラベル付けされたオブジェクトが返されます。 指定できるバージョンまたはラベル パラメーターは 1 つだけです。 両方が見当たっていない場合は、Environment オブジェクトの最新バージョンが返されます。

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

パラメーター

名前 説明
workspace
必須
Workspace

環境を含むワークスペース。
name
必須
str

返す環境の名前。
version
str

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

規定値: None
label
str

環境ラベルの値。

規定値: None

戻り値

型 説明
Environment

環境オブジェクト。

get_image_details

画像の詳細を返します。

get_image_details(workspace)

パラメーター

名前 説明
workspace
必須
Workspace

ワークスペース。

戻り値

型 説明
DockerImageDetails

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

label

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

static label(workspace, name, version, labels)

パラメーター

名前 説明
workspace
必須
Workspace

ワークスペース
name
必須
str

環境名
version
必須
str

環境バージョン
labels
必須
list[str]

Environment にラベルを付ける値

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

戻り値

型 説明
Environment

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

save_to_directory

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

save_to_directory(path, overwrite=False)

パラメーター

名前 説明
path
必須
str

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

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

規定値: False

属性

environment_variables

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