你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Environment 类

用于训练的环境。

继承
azure.ai.ml.entities._assets.asset.Asset
Environment
azure.ai.ml.entities._mixins.LocalizableMixin
Environment

构造函数

Environment(*, name: str | None = None, version: str | None = None, description: str | None = None, image: str | None = None, build: BuildContext | None = None, conda_file: str | PathLike | None = None, tags: Dict | None = None, properties: Dict | None = None, datastore: str | None = None, **kwargs)

参数

name
str
必需

资源的名称。

version
str
必需

资产的版本。

description
str
必需

资源的说明。

image
str
必需

自定义基础映像的 URI。

build
BuildContext
必需

用于创建环境的 Docker 生成上下文。 与“图像”互斥

conda_file
Union[str, PathLike]
必需

列出要安装的 conda 包的配置文件的路径。

tags
dict[str, str]
必需

标记字典。 可以添加、删除和更新标记。

properties
dict[str, str]
必需

资产属性字典。

datastore
str
必需

将本地项目上传到的数据存储。

kwargs
dict
必需

其他配置参数的字典。

示例

创建 Environment 对象。


   from azure.ai.ml.entities._assets.environment import Environment

   environment = Environment(
       name="env-name",
       version="2.0",
       description="env-description",
       image="env-image",
       conda_file="./sdk/ml/azure-ai-ml/tests/test_configs/deployments/model-1/environment/conda.yml",
       tags={"tag1": "value1", "tag2": "value2"},
       properties={"prop1": "value1", "prop2": "value2"},
       datastore="datastore",
   )

方法

dump

将资产内容转储到 YAML 格式的文件中。

validate

通过检查环境的名称、映像和生成来验证环境

dump

将资产内容转储到 YAML 格式的文件中。

dump(dest: str | PathLike | IO, **kwargs) -> None

参数

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
必需

要向其写入 YAML 内容的本地路径或文件流。 如果 dest 是文件路径,则将创建一个新文件。 如果 dest 是打开的文件,则将直接写入该文件。

kwargs
dict

要传递给 YAML 序列化程序的其他参数。

例外

如果 dest 是文件路径且文件已存在,则引发。

如果 dest 是打开的文件且文件不可写,则引发。

validate

通过检查环境的名称、映像和生成来验证环境

validate()

例外

如果 dest 是文件路径且文件已存在,则引发。

如果 dest 是打开的文件且文件不可写,则引发。

示例

验证环境示例。


   from azure.ai.ml.entities import BuildContext, Environment

   env_docker_context = Environment(
       build=BuildContext(
           path="./sdk/ml/azure-ai-ml/tests/test_configs/environment/environment_files",
           dockerfile_path="DockerfileNonDefault",
       ),
       name="create-environment",
       version="2.0",
       description="Environment created from a Docker context.",
   )

   env_docker_context.validate()

属性

base_path

资源的基路径。

返回

资源的基路径。

返回类型

str

conda_file

Conda 环境规范。

返回

conda_file 参数加载的 Conda 依赖项。

返回类型

creation_context

资源的创建上下文。

返回

资源的创建元数据。

返回类型

id

资源 ID。

返回

资源的全局 ID,Azure 资源管理器 (ARM) ID。

返回类型

version

资产版本。

返回

资产版本。

返回类型

str