CondaDependencies 类

在 Azure 机器学习环境中管理应用程序依赖项。

注意

如果未指定任何参数，则会添加 azureml-defaults 作为唯一的 pip 依赖项。

如果未指定 conda_dependencies_file_path 参数，则 CondaDependencies 对象只包含 Azure 机器学习包 (azureml-defaults)。 azureml-defaults 依赖项将不会固定到特定版本，而是以 PyPi 上可用的最新版本为目标。

初始化新对象以管理依赖项。

继承

builtins.object

CondaDependencies

构造函数

CondaDependencies(conda_dependencies_file_path=None, _underlying_structure=None)

参数

conda_dependencies_file_path

str

默认值: None

conda 配置文件的本地路径。 使用此参数可以加载和编辑现有的 Conda 环境文件。

_underlying_structure

默认值: None

注解

可以加载现有的 conda 环境文件，或者选择在内存中配置和管理应用程序依赖项。 在试验提交过程中，将执行一个准备步骤来创建和缓存 conda 环境，试验将在此环境中执行。

如果依赖项可通过 Conda 和 pip（通过 PyPi）使用，请使用 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 包。 注意 添加已引用包的依赖项会删除以前的引用，并在依赖项列表的末尾添加一个新引用。 这可能会更改依赖项的顺序。
add_tensorflow_conda_package	添加 TensorFlow conda 包。
add_tensorflow_pip_package	添加 TensorFlow pip 包。
as_dict	返回 conda 依赖项。
create	初始化新的 CondaDependencies 对象。 返回具有用户指定依赖项的 CondaDependencies 对象实例。 注意 如果未指定 pip_packages，则将添加 azureml-defaults 作为默认依赖项。 用户指定的 pip_packages 依赖项将重写默认值。 如果 pin_sdk_version 设置为 true，则作为 Azure 机器学习 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

“cpu”或“gpu”。

add_conda_package

添加 conda 包。

add_conda_package(conda_package)

参数

conda_package

str

必需

要添加的 conda 包。

add_pip_package

添加 pip 包。

注意

添加已引用包的依赖项会删除以前的引用，并在依赖项列表的末尾添加一个新引用。 这可能会更改依赖项的顺序。

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

“cpu”或“gpu”。

version

str

默认值: None

包版本。

add_tensorflow_pip_package

添加 TensorFlow pip 包。

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

参数

core_type

str

默认值: cpu

“cpu”或“gpu”。

version

str

默认值: None

包版本。

as_dict

返回 conda 依赖项。

as_dict() -> Any

create

初始化新的 CondaDependencies 对象。

返回具有用户指定依赖项的 CondaDependencies 对象实例。

注意

如果未指定 pip_packages，则将添加 azureml-defaults 作为默认依赖项。 用户指定的 pip_packages 依赖项将重写默认值。

如果 pin_sdk_version 设置为 true，则作为 Azure 机器学习 Python SDK 的一部分分发的包 pip 依赖项将被固定到当前环境中安装的 SDK 版本。

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

参数

pip_indexurl

str

默认值: None

pip 索引 URL。 如果未指定，将使用 SDK 源索引 URL。

pip_packages

list[str]

默认值: None

pip 包的列表。

conda_packages

list[str]

默认值: None

conda 包的列表。

python_version

str

默认值: 3.8.13

Python 版本。

pin_sdk_version

bool

默认值: True

指示是否将 SDK 包固定到客户端版本。

返回

一个 conda 依赖项对象。

返回类型

CondaDependencies

get_default_number_of_packages

返回默认的包数。

get_default_number_of_packages()

返回

conda 和 pip 包的默认数量。

返回类型

int

get_python_version

返回 Python 版本。

get_python_version()

返回

Python 版本。

返回类型

str

merge_requirements

合并包要求。

static merge_requirements(requirements)

参数

requirements

list[str]

必需

要合并的包要求列表。

返回

合并的包要求列表。

返回类型

list[str]

remove_channel

删除 conda 通道。

remove_channel(channel)

参数

channel

str

必需

要删除的 conada 通道。

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

要保存到的文件的完全限定路径。

返回

规范化的 conda 路径。

返回类型

str

例外

UserErrorException

因保存依赖项时出现问题而引发。

save_to_file

已弃用，请使用 save。

将 conda 依赖项对象保存到文件。

save_to_file(base_directory, conda_file_path=None)

参数

base_directory

str

必需

用以保存文件的基本目录。

conda_file_path

str

默认值: None

文件名。

返回

规范化的 conda 路径。

返回类型

str

sdk_origin_url

返回 SDK 源索引 URL。

static sdk_origin_url()

返回

返回 SDK 源索引 URL。

返回类型

str

serialize_to_string

将 conda 依赖项对象序列化为字符串。

serialize_to_string()

返回

序列化为字符串的 conda 依赖项对象。

返回类型

str

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 通道。

返回

返回通道依赖项。 返回的依赖项是一个副本，对返回通道进行任何更改不会更新此对象中的 conda 通道。

返回类型

iter

conda_packages

返回 conda 包。

返回

返回包依赖项。 返回 conda 包的副本，对返回的列表进行的任何编辑不会反映在此对象的 conda 包中。

返回类型

iter

pip_options

返回 pip 选项。

返回

返回 pip 选项。 返回 pip 选项的副本，对返回的列表进行的任何编辑不会反映在此对象的 pip 选项中。

返回类型

iter

pip_packages

返回 pip 依赖项。

返回

返回 pip 依赖项。 返回 pip 包的副本，对返回的列表进行的任何编辑不会反映在此对象的 pip 包中。

返回类型

iter

DEFAULT_NUMBER_OF_CONDA_PACKAGES

DEFAULT_NUMBER_OF_CONDA_PACKAGES = 0

DEFAULT_NUMBER_OF_PIP_PACKAGES

DEFAULT_NUMBER_OF_PIP_PACKAGES = 0