InferenceConfig 类

表示用于部署的自定义环境的配置设置。

推理配置是部署相关作的 Model 输入参数:

初始化配置对象。

构造函数

InferenceConfig(entry_script, runtime=None, conda_file=None, extra_docker_file_steps=None, source_directory=None, enable_gpu=None, description=None, base_image=None, base_image_registry=None, cuda_version=None, environment=None)

参数

名称 说明
entry_script
必需
str

包含要为映像运行的代码的本地文件的路径。

runtime
str

要用于映像的运行时。 当前支持的运行时是“spark-py”和“python”。

默认值: None
conda_file
str

包含要用于映像的 conda 环境定义的本地文件的路径。

默认值: None
extra_docker_file_steps
str

本地文件的路径,其中包含设置映像时要运行的其他 Docker 步骤。

默认值: None
source_directory
str

包含要创建映像的所有文件的文件夹的路径。

默认值: None
enable_gpu

指示是否在映像中启用 GPU 支持。 GPU 映像必须用于 Microsoft Azure 服务,例如 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务。 默认为 False。

默认值: None
description
str

提供此映像的说明。

默认值: None
base_image
str

要用作基础映像的自定义映像。 如果未提供基础映像,则基于给定的运行时参数使用基础映像。

默认值: None
base_image_registry

包含基本映像的映像注册表。

默认值: None
cuda_version
str

要针对需要 GPU 支持的映像安装的 CUDA 版本。 GPU 映像必须用于 Microsoft Azure 服务,例如 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务。 支持的版本为 9.0、9.1 和 10.0。 如果 enable_gpu 已设置,则默认为“9.1”。

默认值: None
environment

要用于部署的环境对象。 无需注册环境。

提供此参数或其他参数,但不能同时提供这两个参数。 各个参数将不用作环境对象的替代。 异常包括 entry_scriptsource_directorydescription

默认值: None
entry_script
必需
str

包含要为映像运行的代码的本地文件的路径。

runtime
必需
str

要用于映像的运行时。 当前支持的运行时是“spark-py”和“python”。

conda_file
必需
str

包含要用于映像的 conda 环境定义的本地文件的路径。

extra_docker_file_steps
必需
str

本地文件的路径,其中包含设置映像时要运行的其他 Docker 步骤。

source_directory
必需
str

包含要创建映像的所有文件的文件夹的路径。

enable_gpu
必需

指示是否在映像中启用 GPU 支持。 GPU 映像必须用于 Microsoft Azure 服务,例如 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务。 默认为 False。

description
必需
str

提供此映像的说明。

base_image
必需
str

要用作基础映像的自定义映像。 如果未提供基础映像,则基于给定的运行时参数使用基础映像。

base_image_registry
必需

包含基本映像的映像注册表。

cuda_version
必需
str

要针对需要 GPU 支持的映像安装的 CUDA 版本。 GPU 映像必须用于 Microsoft Azure 服务,例如 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务。 支持的版本为 9.0、9.1 和 10.0。 如果 enable_gpu 已设置,则默认为“9.1”。

environment
必需

要用于部署的环境对象。 无需注册环境。

提供此参数或其他参数,但不能同时提供这两个参数。 各个参数将不用作环境对象的替代。 异常包括 entry_scriptsource_directorydescription

注解

以下示例演示如何创建 InferenceConfig 对象并使用它来部署模型。


   from azureml.core.model import InferenceConfig
   from azureml.core.webservice import AciWebservice


   service_name = 'my-custom-env-service'

   inference_config = InferenceConfig(entry_script='score.py', environment=environment)
   aci_config = AciWebservice.deploy_configuration(cpu_cores=1, memory_gb=1)

   service = Model.deploy(workspace=ws,
                          name=service_name,
                          models=[model],
                          inference_config=inference_config,
                          deployment_config=aci_config,
                          overwrite=True)
   service.wait_for_deployment(show_output=True)

变量

名称 说明
entry_script
str

包含要为映像运行的代码的本地文件的路径。

runtime
str

要用于映像的运行时。 当前支持的运行时是“spark-py”和“python”。

conda_file
str

包含要用于映像的 conda 环境定义的本地文件的路径。

extra_docker_file_steps
str

本地文件的路径,其中包含设置映像时要运行的其他 Docker 步骤。

source_directory
str

包含要创建映像的所有文件的文件夹的路径。

enable_gpu

指示是否在映像中启用 GPU 支持。 GPU 映像必须用于 Microsoft Azure 服务,例如 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务。

azureml.core.model.InferenceConfig.description

提供此映像的说明。

base_image
str

要用作基础映像的自定义映像。 如果未提供基础映像,则基于给定的运行时参数使用基础映像。

base_image_registry

包含基本映像的映像注册表。

cuda_version
str

要为需要 GPU 支持的映像安装的 CUDA 版本。 GPU 映像必须用于 Microsoft Azure 服务,例如 Azure 容器实例、Azure 机器学习计算、Azure 虚拟机和 Azure Kubernetes 服务。 支持的版本为 9.0、9.1 和 10.0。 如果 enable_gpu 已设置,则默认为“9.1”。

azureml.core.model.InferenceConfig.environment

要用于部署的环境对象。 无需注册环境。

提供此参数或其他参数,但不能同时提供这两个参数。 各个参数将不用作环境对象的替代。 异常包括 entry_scriptsource_directorydescription

方法

build_create_payload

生成容器映像的创建有效负载。

build_profile_payload

为模型包生成分析有效负载。

validate_configuration

检查指定的配置值是否有效。

如果验证失败,则引发验证 WebserviceException

validation_script_content

检查分数脚本的语法是否对 ast.parse 有效。

如果验证失败,则引发验证 UserErrorException

build_create_payload

生成容器映像的创建有效负载。

build_create_payload(workspace, name, model_ids)

参数

名称 说明
workspace
必需

要在其中创建映像的工作区对象。

name
必需
str

图像的名称。

model_ids
必需

要打包到映像中的模型 ID 的列表。

返回

类型 说明

容器映像创建有效负载。

例外

类型 说明

build_profile_payload

为模型包生成分析有效负载。

build_profile_payload(profile_name, input_data=None, workspace=None, models=None, dataset_id=None, container_resource_requirements=None, description=None)

参数

名称 说明
profile_name
必需
str

分析运行的名称。

input_data
str

用于分析的输入数据。

默认值: None
workspace

要在其中分析模型的 Workspace 对象。

默认值: None
models

模型对象列表。 可以是空列表。

默认值: None
dataset_id
str

与包含分析运行的输入数据的数据集关联的 ID。

默认值: None
container_resource_requirements

要向其部署模型的最大实例的容器资源要求

默认值: None
description
str

要与分析运行关联的说明。

默认值: None

返回

类型 说明

模型配置文件有效负载

例外

类型 说明

validate_configuration

检查指定的配置值是否有效。

如果验证失败,则引发验证 WebserviceException

validate_configuration()

例外

类型 说明

validation_script_content

检查分数脚本的语法是否对 ast.parse 有效。

如果验证失败,则引发验证 UserErrorException

validation_script_content()

例外

类型 说明