CondaDependencies 類別

管理 Azure Machine Learning 環境中的應用程式相依性。

注意

如果未指定任何參數,則會將 azureml-defaults 新增為唯一的 pip 相依性。

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
預設值: None

conda 組態檔的本機路徑。 使用此參數可讓您載入和編輯現有的 Conda 環境檔案。

_underlying_structure
預設值: None

備註

您可以載入現有的 conda 環境檔案,或選擇設定和管理記憶體中的應用程式相依性。 在實驗提交期間,會執行準備步驟,以建立和快取實驗執行所在的 conda 環境。

如果您的相依性可透過 PyPi) 的 Conda 和 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 套件。

注意

新增已參考套件的相依性將會移除先前的參考,並將新的參考新增至相依性清單結尾。 這可能會變更相依性的順序。

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

傳回類型

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 Machine Learning 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 相依性物件。

傳回類型

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]
必要

要合併的套件需求清單。

傳回

合併套件需求的清單。

傳回類型

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

例外狀況

針對儲存相依性的問題引發。

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 版本。

傳回類型

屬性

conda_channels

傳回 conda 通道。

傳回

傳回信道相依性。 傳回的相依性是複本,傳回的通道的任何變更都不會更新此物件中的 conda 通道。

傳回類型

conda_packages

傳回 conda 套件。

傳回

傳回套件相依性。 傳回 conda 套件的複本,且傳回清單的任何編輯都不會反映在此物件的 conda 套件中。

傳回類型

pip_options

傳回 pip 選項。

傳回

傳回 pip 選項。 傳回 pip 選項的複本,且傳回清單的任何編輯都不會反映在此物件的 pip 選項中。

傳回類型

pip_packages

傳回 pip 相依性。

傳回

傳回 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