CondaDependencies クラス

  • リファレンス

Azure Machine Learning 環境内のアプリケーションの依存関係を管理します。

Note

パラメーターが指定されていない場合、唯一の pip 依存関係として azureml-defaults が追加されます。

conda_dependencies_file_path パラメーターが指定されていない場合、CondaDependencies オブジェクトには、Azure Machine Learning パッケージ (azureml-defaults) のみが含まれます。 azureml-defaults 依存関係は、特定のバージョンにピン留めされず、PyPi で使用できる最新バージョンをターゲットとします。

依存関係を管理するために新しいオブジェクトを初期化します。

継承
builtins.object
CondaDependencies

コンストラクター

CondaDependencies(conda_dependencies_file_path=None, _underlying_structure=None)

パラメーター

名前 説明
conda_dependencies_file_path
str

Conda 構成ファイルへのローカル パス。 このパラメーターを使用すると、既存の Conda 環境ファイルを読み込み、編集できます。

規定値: None
_underlying_structure
規定値: None

注釈

既存の Conda 環境ファイルを読み込むこと、またはメモリでアプリケーションの依存関係を構成して管理することができます。 実験の送信時に、Conda 環境を作成してキャッシュする準備手順が実行されます。この Conda 環境内で実験は実行されます。

依存関係が Conda と (PyPi からの) pip の両方で利用できる場合、Conda バージョンを使用してください。これは、Conda パッケージには、インストールの信頼性を高めるビルド済みのバイナリが通常付属しているためです。 詳細については、「Conda と Pip について」を参照してください。

基本イメージの依存関係について詳しくは、リポジトリ https://github.com/Azure/AzureML-Containers を参照してください。

次の例は、add_conda_package を使用してパッケージを追加する方法を示しています。


   from azureml.core.authentication import MsiAuthentication

   msi_auth = MsiAuthentication()

   ws = Workspace(subscription_id="my-subscription-id",
                  resource_group="my-ml-rg",
                  workspace_name="my-ml-workspace",
                  auth=msi_auth)

   print("Found workspace {} at location {}".format(ws.name, ws.location))

完全なサンプルは、https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb から入手できます

pip パッケージも追加できます。依存関係は Environment オブジェクトで設定されます。


   conda_dep.add_pip_package("pillow==6.2.1")
   myenv.python.conda_dependencies=conda_dep

完全なサンプルは、https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/training/using-environments/using-environments.ipynb から入手できます

メソッド

add_channel

Conda チャネルを追加します。

チャネルの一覧については、https://docs.anaconda.com/anaconda/user-guide/tasks/using-repositories/ を参照してください
add_cntk_package

Microsoft Cognitive Toolkit (CNTK) パッケージを追加します。
add_conda_package

Conda パッケージを追加します。
add_pip_package

pip パッケージを追加します。

Note

既に参照されているパッケージの依存関係を追加すると、前の参照が削除され、依存関係リストの末尾に新しい参照が追加されます。 これにより、依存関係の順序が変更される可能性があります。
add_tensorflow_conda_package

Tensorflow Conda パッケージを追加します。
add_tensorflow_pip_package

Tensorflow pip パッケージを追加します。
as_dict

Conda の依存関係を返します。
create

新しい CondaDependencies オブジェクトを初期化します。

ユーザー指定の依存関係を含む CondaDependencies オブジェクトのインスタンスを返します。

Note

pip_packages が指定されていない場合、azureml-defaults が既定の依存関係として追加されます。 ユーザー指定の pip_packages 依存関係により、既定値はオーバーライドされます。

pin_sdk_version が true に設定されている場合、Azure Machine Learning Python SDK の一部として配布されるパッケージの pip 依存関係は、現在の環境にインストールされている SDK のバージョンに合わせて固定されます。
get_default_number_of_packages

パッケージの既定の数を返します。
get_python_version

Python のバージョンを返します。
merge_requirements

パッケージ要件をマージします。
remove_channel

Conda チャネルを削除します。
remove_conda_package

Conda パッケージを削除します。
remove_pip_option

pip オプションを削除します。
remove_pip_package

pip パッケージを削除します。
save

Conda 依存関係オブジェクトをファイルに保存します。
save_to_file

非推奨です。save を使用してください。

Conda 依存関係オブジェクトをファイルに保存します。
sdk_origin_url

SDK の元のインデックス URL を返します。
serialize_to_string

Conda 依存関係オブジェクトを文字列にシリアル化します。
set_pip_index_url

pip インデックス URL を設定します。
set_pip_option

pip オプションを追加します。
set_pip_requirements

Conda 依存関係の pip セクション全体を上書きします。
set_python_version

Python バージョンを設定します。

add_channel

Conda チャネルを追加します。

チャネルの一覧については、https://docs.anaconda.com/anaconda/user-guide/tasks/using-repositories/ を参照してください

add_channel(channel)

パラメーター

名前 説明
channel
必須
str

追加する Conda チャネル。

戻り値

型 説明
None

add_cntk_package

Microsoft Cognitive Toolkit (CNTK) パッケージを追加します。

add_cntk_package(core_type='cpu')

パラメーター

名前 説明
core_type
str

'cpu' または 'gpu'。

規定値: cpu

add_conda_package

Conda パッケージを追加します。

add_conda_package(conda_package)

パラメーター

名前 説明
conda_package
必須
str

追加する Conda パッケージ。

add_pip_package

pip パッケージを追加します。

Note

既に参照されているパッケージの依存関係を追加すると、前の参照が削除され、依存関係リストの末尾に新しい参照が追加されます。 これにより、依存関係の順序が変更される可能性があります。

add_pip_package(pip_package)

パラメーター

名前 説明
pip_package
必須
str

追加する pip パッケージ。

add_tensorflow_conda_package

Tensorflow Conda パッケージを追加します。

add_tensorflow_conda_package(core_type='cpu', version=None)

パラメーター

名前 説明
core_type
str

'cpu' または 'gpu'。

規定値: cpu
version
str

パッケージのバージョンです。

規定値: None

add_tensorflow_pip_package

Tensorflow pip パッケージを追加します。

add_tensorflow_pip_package(core_type='cpu', version=None)

パラメーター

名前 説明
core_type
str

'cpu' または 'gpu'。

規定値: cpu
version
str

パッケージのバージョンです。

規定値: None

as_dict

Conda の依存関係を返します。

as_dict() -> Any

create

新しい CondaDependencies オブジェクトを初期化します。

ユーザー指定の依存関係を含む CondaDependencies オブジェクトのインスタンスを返します。

Note

pip_packages が指定されていない場合、azureml-defaults が既定の依存関係として追加されます。 ユーザー指定の pip_packages 依存関係により、既定値はオーバーライドされます。

pin_sdk_version が true に設定されている場合、Azure Machine Learning Python SDK の一部として配布されるパッケージの pip 依存関係は、現在の環境にインストールされている SDK のバージョンに合わせて固定されます。

static create(pip_indexurl=None, pip_packages=None, conda_packages=None, python_version='3.9.12', pin_sdk_version=True)

パラメーター

名前 説明
pip_indexurl
str

pip インデックス URL。 指定しない場合、SDK の元のインデックス URL が使用されます。

規定値: None
pip_packages
list[str]

pip パッケージのリスト。

規定値: None
conda_packages
list[str]

Conda パッケージのリスト。

規定値: None
python_version
str

Python のバージョン。

規定値: 3.9.12
pin_sdk_version
bool

SDK パッケージをクライアント バージョンに合わせて固定するかどうかを示します。

規定値: True

戻り値

型 説明
CondaDependencies

Conda 依存関係オブジェクト。

get_default_number_of_packages

パッケージの既定の数を返します。

get_default_number_of_packages()

戻り値

型 説明
int

Conda および pip パッケージの既定の数。

get_python_version

Python のバージョンを返します。

get_python_version()

戻り値

型 説明
str

Python のバージョン。

merge_requirements

パッケージ要件をマージします。

static merge_requirements(requirements)

パラメーター

名前 説明
requirements
必須
list[str]

マージするパッケージ要件のリスト。

戻り値

型 説明
list[str]

マージされたパッケージ要件のリスト。

remove_channel

Conda チャネルを削除します。

remove_channel(channel)

パラメーター

名前 説明
channel
必須
str

削除する Conda チャネル。

remove_conda_package

Conda パッケージを削除します。

remove_conda_package(conda_package)

パラメーター

名前 説明
conda_package
必須
str

削除する Conda パッケージ。

remove_pip_option

pip オプションを削除します。

remove_pip_option(pip_option)

パラメーター

名前 説明
pip_option
必須
str

削除する pip オプション。

remove_pip_package

pip パッケージを削除します。

remove_pip_package(pip_package)

パラメーター

名前 説明
pip_package
必須
str

削除する pip パッケージ。

save

Conda 依存関係オブジェクトをファイルに保存します。

save(path=None)

パラメーター

名前 説明
path
str

保存する先のファイルの完全修飾パス。

規定値: None

戻り値

型 説明
str

正規化された Conda パス。

例外

型 説明
UserErrorException

依存関係の保存に問題がある場合に発生します。

save_to_file

非推奨です。save を使用してください。

Conda 依存関係オブジェクトをファイルに保存します。

save_to_file(base_directory, conda_file_path=None)

パラメーター

名前 説明
base_directory
必須
str

ファイルを保存するベース ディレクトリ。
conda_file_path
str

ファイル名。

規定値: None

戻り値

型 説明
str

正規化された Conda パス。

sdk_origin_url

SDK の元のインデックス URL を返します。

static sdk_origin_url()

戻り値

型 説明
str

SDK の元のインデックス URL を返します。

serialize_to_string

Conda 依存関係オブジェクトを文字列にシリアル化します。

serialize_to_string()

戻り値

型 説明
str

文字列にシリアル化された Conda 依存関係オブジェクト。

set_pip_index_url

pip インデックス URL を設定します。

set_pip_index_url(index_url)

パラメーター

名前 説明
index_url
必須
str

使用する pip インデックス URL。

set_pip_option

pip オプションを追加します。

set_pip_option(pip_option)

パラメーター

名前 説明
pip_option
必須
str

追加する pip オプション。

set_pip_requirements

Conda 依存関係の pip セクション全体を上書きします。

set_pip_requirements(pip_requirements)

パラメーター

名前 説明
pip_requirements
必須
list[str]

pip パッケージとオプションのリスト。

set_python_version

Python バージョンを設定します。

set_python_version(version)

パラメーター

名前 説明
version
必須
str

追加する Python バージョン。

戻り値

型 説明
None

属性

conda_channels

Conda チャネルを返します。

戻り値

型 説明
iter

チャネルの依存関係を返します。 返される依存関係はコピーであり、返されたチャネルに変更を加えても、このオブジェクトの Conda チャネルは更新されません。

conda_packages

Conda パッケージを返します。

戻り値

型 説明
iter

パッケージの依存関係を返します。 Conda パッケージのコピーを返します。返されたリストを編集しても、このオブジェクトの Conda パッケージには反映されません。

pip_options

pip オプションを返します。

戻り値

型 説明
iter

pip オプションを返します。 pip オプションのコピーを返します。返されたリストを編集しても、このオブジェクトの pip オプションには反映されません。

pip_packages

pip の依存関係を返します。

戻り値

型 説明
iter

pip の依存関係を返します。 pip パッケージのコピーを返します。返されたリストを編集しても、このオブジェクトの pip パッケージには反映されません。

DEFAULT_NUMBER_OF_CONDA_PACKAGES 

DEFAULT_NUMBER_OF_CONDA_PACKAGES = 0

DEFAULT_NUMBER_OF_PIP_PACKAGES 

DEFAULT_NUMBER_OF_PIP_PACKAGES = 0