ContainerImageConfig 类
定义特定于容器部署的映像配置设置 - 需要执行脚本和运行时。
在典型用例中,你将使用 ContainerImage 类的 image_configuration
方法来创建 ContainerImageConfig 对象。
初始化 config 对象。
- 继承
-
ContainerImageConfig
构造函数
ContainerImageConfig(execution_script, runtime, conda_file=None, docker_file=None, schema_file=None, dependencies=None, enable_gpu=None, tags=None, properties=None, description=None, base_image=None, base_image_registry=None, allow_absolute_path=False, cuda_version=None)
参数
名称 | 说明 |
---|---|
execution_script
必需
|
包含要为映像运行的代码的本地文件的路径。 |
runtime
必需
|
用于映像的运行时。 目前支持的运行时为“spark-py”和“python”。 |
conda_file
|
包含用于映像的 Conda 环境定义的本地文件的路径。 默认值: None
|
docker_file
|
包含设置映像时要运行的其他 Docker 步骤的本地文件的路径。 默认值: None
|
schema_file
|
包含部署映像时要使用的 Web 服务架构的本地文件的路径。 默认值: None
|
dependencies
|
映像需要运行的其他文件/文件夹的路径列表。 默认值: None
|
enable_gpu
|
是否在映像中启用 GPU 支持。 GPU 映像必须用于 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务等 Microsoft Azure 服务。 默认为 False。 默认值: None
|
tags
|
为此映像指定的键值标记字典。 默认值: None
|
properties
|
为此映像指定的键值属性字典。 这些属性在部署后无法更改,但是可以添加新的键值对。 默认值: None
|
description
|
为此映像指定的说明。 默认值: None
|
base_image
|
用作基础映像的自定义映像。 如果未提供基础映像,则基于给定的运行时参数使用基础映像。 默认值: None
|
base_image_registry
|
包含基础映像的映像注册表。 默认值: None
|
allow_absolute_path
|
指示是否允许绝对路径。 默认值: False
|
cuda_version
|
要为需要 GPU 支持的映像安装的 CUDA 版本。 GPU 映像必须用于 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务等 Microsoft Azure 服务。 支持的版本为 9.0、9.1 和 10.0。 如果设置了“enable_gpu”,则默认为“9.1”。 默认值: None
|
execution_script
必需
|
包含要为映像运行的代码的本地文件的路径 |
runtime
必需
|
用于映像的运行时。 当前支持的运行时为“spark-py”和“python” |
conda_file
必需
|
包含要用于映像的 conda 环境定义的本地文件的路径 |
docker_file
必需
|
本地文件的路径,其中包含设置映像时要运行的其他 Docker 步骤 |
schema_file
必需
|
包含部署映像时要使用的 Web 服务架构的本地文件的路径 |
dependencies
必需
|
映像需要运行的其他文件/文件夹的路径列表 |
enable_gpu
必需
|
是否在映像中启用 GPU 支持。 GPU 映像必须用于 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务等 Microsoft Azure 服务。 默认为 false。 |
tags
必需
|
用于提供此图像的键值标记字典 |
properties
必需
|
提供此映像的键值属性字典。 这些属性在部署后无法更改,但可以添加新的键值对 |
description
必需
|
提供此图像的说明 |
base_image
必需
|
要用作基础映像的自定义映像。 如果未提供基础映像,则基于给定的运行时参数使用基础映像。 |
base_image_registry
必需
|
包含基础映像的映像注册表。 |
allow_absolute_path
必需
|
允许绝对路径的标志 |
cuda_version
必需
|
要为需要 GPU 支持的映像安装的 CUDA 版本。 GPU 映像必须用于 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务等 Microsoft Azure 服务。 支持的版本为 9.0、9.1 和 10.0。 如果设置了“enable_gpu”,则默认值为“9.1”。 |
方法
build_create_payload |
生成容器映像的创建有效负载。 |
create_local_debug_payload |
生成容器映像的创建有效负载。 |
validate_configuration |
检查指定的配置值是否有效。 如果验证失败,则引发 :class:azureml.exceptions.WebserviceException`。 |
build_create_payload
生成容器映像的创建有效负载。
build_create_payload(workspace, name, model_ids)
参数
名称 | 说明 |
---|---|
workspace
必需
|
要在其中创建映像的工作区对象。 |
name
必需
|
图像的名称。 |
model_ids
必需
|
要打包到映像中的模型 ID 的列表。 |
返回
类型 | 说明 |
---|---|
容器映像创建有效负载。 |
例外
类型 | 说明 |
---|---|
create_local_debug_payload
生成容器映像的创建有效负载。
create_local_debug_payload(workspace, model_ids)
参数
名称 | 说明 |
---|---|
workspace
必需
|
要在其中创建映像的工作区对象。 |
model_ids
必需
|
要打包到映像中的模型 ID 的列表。 |
返回
类型 | 说明 |
---|---|
容器映像创建有效负载。 |
例外
类型 | 说明 |
---|---|
validate_configuration
检查指定的配置值是否有效。
如果验证失败,则引发 :class:azureml.exceptions.WebserviceException`。
validate_configuration()
例外
类型 | 说明 |
---|---|