AksServiceDeploymentConfiguration 类

表示在 Azure Kubernetes 服务上部署的服务的部署配置信息。

使用 deploy_configuration 类的方法 AksWebservice 创建 AksServiceDeploymentConfiguration 对象。

初始化用于部署到 AKS 计算目标的配置对象。

构造函数

AksServiceDeploymentConfiguration(autoscale_enabled, autoscale_min_replicas, autoscale_max_replicas, autoscale_refresh_seconds, autoscale_target_utilization, collect_model_data, auth_enabled, cpu_cores, memory_gb, enable_app_insights, scoring_timeout_ms, replica_max_concurrent_requests, max_request_wait_time, num_replicas, primary_key, secondary_key, tags, properties, description, gpu_cores, period_seconds, initial_delay_seconds, timeout_seconds, success_threshold, failure_threshold, namespace, token_auth_enabled, compute_target_name, cpu_cores_limit, memory_gb_limit, blobfuse_enabled=None)

参数

名称 说明
cpu_cores_limit
必需

允许此 Web 服务使用的最大 CPU 核心数。 可以是小数。

memory_gb_limit
必需

允许使用此 Web 服务的最大内存量(以 GB 为单位)。 可以是小数。

autoscale_enabled
必需

指示是否为此 Web 服务启用自动缩放。 默认值为 True(如果 num_replicas 为 None)。

autoscale_min_replicas
必需
int

自动缩放此 Web 服务时要使用的最小容器数。 默认值为 1。

autoscale_max_replicas
必需
int

自动缩放此 Web 服务时要使用的容器的最大数目。 默认值为 10

autoscale_refresh_seconds
必需
int

自动缩放程序应尝试缩放此 Web 服务的频率。 默认值为 1。

autoscale_target_utilization
必需
int

自动缩放程序应尝试维护此 Web 服务的目标利用率(以 100% 中的百分比为单位)。 默认值为 70。

collect_model_data
必需

是否为此 Web 服务启用模型数据收集。 默认为 False。

auth_enabled
必需

是否为此 Web 服务启用身份验证。 默认为 True。

cpu_cores
必需

要为此 Web 服务分配的 CPU 核心数。 可以是小数。 默认值为 0.1

memory_gb
必需

要为此 Web 服务分配的内存量(以 GB 为单位)。 可以是小数。 默认值为 0.5

enable_app_insights
必需

是否为此 Web 服务启用 Application Insights 日志记录。 默认为 False

scoring_timeout_ms
必需
int

用于对此 Web 服务进行评分调用的超时。 默认值为 60000。

replica_max_concurrent_requests
必需
int

允许此 Web 服务的每个副本的最大并发请求数。 默认值为 1。 除非Microsoft技术支持或 Azure 机器学习团队的成员指示,否则不要从默认值 1 更改此设置。

max_request_wait_time
必需
int

在返回 503 错误之前,请求将停留在队列中(以毫秒为单位)的最大时间。 默认值为 500。

num_replicas
必需
int

要为此 Web 服务分配的容器数。 如果未设置此参数,则默认启用自动缩放程序。

primary_key
必需
str

用于此 Web 服务的主身份验证密钥。

secondary_key
必需
str

用于此 Web 服务的辅助身份验证密钥。

tags
必需

要为此 Web 服务提供键值标记的字典。

properties
必需

要为此 Web 服务提供键值属性的字典。 部署后无法更改这些属性,但可以添加新的键值对。

description
必需
str

提供此 Web 服务的说明。

gpu_cores
必需
int

要为此 Web 服务分配的 GPU 核心数。 默认值为 0。

period_seconds
必需
int

执行运行情况探测的频率(秒)。 默认值为 10 秒。 最小值为 1。

initial_delay_seconds
必需
int

启动生存情况探测之前容器启动后的秒数。 默认值为 310。

timeout_seconds
必需
int

运行情况探测超时的秒数。默认值为 2 秒。 最小值为 1。

success_threshold
必需
int

运行情况探测失败后,将其视为成功所需的最小连续成功次数。 默认值为 1。 最小值为 1。

failure_threshold
必需
int

当 Pod 启动且运行情况探测失败时,Kubernetes 会在放弃之前尝试 failureThreshold 时间。 默认值为 3。 最小值为 1。

namespace
必需
str

要在其中部署此 Web 服务的 Kubernetes 命名空间:最多 63 个小写字母数字('a'-'z'、'0'-'9')和连字符('-')字符。 第一个字符和最后一个字符不能是连字符。

token_auth_enabled
必需

是否为此 Web 服务启用 Azure Active Directory 身份验证。 如果启用此功能,则用户可以使用其 Azure Active Directory 凭据提取访问令牌来访问此 Web 服务。 默认为 False。

cpu_cores_limit
必需

允许此 Web 服务使用的最大 CPU 核心数。 可以是小数。

memory_gb_limit
必需

允许使用此 Web 服务的最大内存量(以 GB 为单位)。 可以是小数。

blobfuse_enabled

是否为此 Web 服务启用模型下载的 blobfuse。 默认值为 True

默认值: None
autoscale_enabled
必需

指示是否为此 Web 服务启用自动缩放。 默认值为 True(如果 num_replicas 为 None)。

autoscale_min_replicas
必需
int

自动缩放此 Web 服务时要使用的最小容器数。 默认值为 1。

autoscale_max_replicas
必需
int

自动缩放此 Web 服务时要使用的容器的最大数目。 默认值为 10

autoscale_refresh_seconds
必需
int

自动缩放程序应尝试缩放此 Web 服务的频率。 默认值为 1。

autoscale_target_utilization
必需
int

自动缩放程序应尝试维护此 Web 服务的目标利用率(以 100% 中的百分比为单位)。 默认值为 70。

collect_model_data
必需

是否为此 Web 服务启用模型数据收集。 默认为 False。

auth_enabled
必需

是否为此 Web 服务启用身份验证。 默认为 True。

cpu_cores
必需

要为此 Web 服务分配的 CPU 核心数。 可以是小数。 默认值为 0.1

memory_gb
必需

要为此 Web 服务分配的内存量(以 GB 为单位)。 可以是小数。 默认值为 0.5

enable_app_insights
必需

是否为此 Web 服务启用 Application Insights 日志记录。 默认为 False

scoring_timeout_ms
必需
int

用于对此 Web 服务进行评分调用的超时。 默认值为 60000。

replica_max_concurrent_requests
必需
int

允许此 Web 服务的每个副本的最大并发请求数。 默认值为 1。 除非Microsoft技术支持或 Azure 机器学习团队的成员指示,否则不要从默认值 1 更改此设置。

max_request_wait_time
必需
int

在返回 503 错误之前,请求将停留在队列中(以毫秒为单位)的最大时间。 默认值为 500。

num_replicas
必需
int

要为此 Web 服务分配的容器数。 如果未设置此参数,则默认启用自动缩放程序。

primary_key
必需
str

用于此 Web 服务的主身份验证密钥。

secondary_key
必需
str

用于此 Web 服务的辅助身份验证密钥。

tags
必需

要为此 Web 服务提供键值标记的字典。

properties
必需

要为此 Web 服务提供键值属性的字典。 部署后无法更改这些属性,但可以添加新的键值对。

description
必需
str

提供此 Web 服务的说明。

gpu_cores
必需
int

要为此 Web 服务分配的 GPU 核心数。 默认值为 0。

period_seconds
必需
int

执行运行情况探测的频率(秒)。 默认值为 10 秒。 最小值为 1。

initial_delay_seconds
必需
int

启动生存情况探测之前容器启动后的秒数。 默认值为 310。

timeout_seconds
必需
int

运行情况探测超时的秒数。默认值为 2 秒。 最小值为 1。

success_threshold
必需
int

运行情况探测失败后,将其视为成功所需的最小连续成功次数。 默认值为 1。 最小值为 1。

failure_threshold
必需
int

当 Pod 启动且运行情况探测失败时,Kubernetes 会在放弃之前尝试 failureThreshold 时间。 默认值为 3。 最小值为 1。

namespace
必需
str

要在其中部署此 Web 服务的 Kubernetes 命名空间:最多 63 个小写字母数字('a'-'z'、'0'-'9')和连字符('-')字符。 第一个字符和最后一个字符不能是连字符。

token_auth_enabled
必需

是否为此 Web 服务启用 Azure Active Directory 身份验证。 如果启用此功能,则用户可以使用其 Azure Active Directory 凭据提取访问令牌来访问此 Web 服务。 默认为 False。

compute_target_name
必需
str

要部署到的计算目标的名称

cpu_cores_limit
必需

允许此 Web 服务使用的最大 CPU 核心数。 可以是小数。

memory_gb_limit
必需

允许使用此 Web 服务的最大内存量(以 GB 为单位)。 可以是小数。

blobfuse_enabled
必需

是否为此 Web 服务启用模型下载的 blobfuse。 默认值为 True

变量

名称 说明
autoscale_enabled

指示是否为此 Web 服务启用自动缩放。 默认值为 True(如果 num_replicas 为 None)。

autoscale_min_replicas
int

自动缩放此 Web 服务时要使用的最小容器数。 默认值为 1。

autoscale_max_replicas
int

自动缩放此 Web 服务时要使用的容器的最大数目。 默认值为 10

autoscale_refresh_seconds
int

自动缩放程序应尝试缩放此 Web 服务的频率。 默认值为 1。

autoscale_target_utilization
int

自动缩放程序应尝试维护此 Web 服务的目标利用率(以 100% 中的百分比为单位)。 默认值为 70。

collect_model_data

是否为此 Web 服务启用模型数据收集。 默认为 False。

auth_enabled

是否为此 Web 服务启用身份验证。 默认为 True。

cpu_cores

要为此 Web 服务分配的 CPU 核心数。 可以是小数。 默认值为 0.1

memory_gb

要为此 Web 服务分配的内存量(以 GB 为单位)。 可以是小数。 默认值为 0.5

enable_app_insights

是否为此 Web 服务启用 Application Insights 日志记录。 默认为 False

scoring_timeout_ms
int

用于对此 Web 服务进行评分调用的超时。 默认值为 60000。

replica_max_concurrent_requests
int

允许此 Web 服务的每个副本的最大并发请求数。 默认值为 1。 除非Microsoft技术支持或 Azure 机器学习团队的成员指示,否则不要从默认值 1 更改此设置。

max_request_wait_time
int

在返回 503 错误之前,请求将停留在队列中(以毫秒为单位)的最大时间。 默认值为 500。

num_replicas
int

要为此 Web 服务分配的容器数。 如果未设置此参数,则默认启用自动缩放程序。

primary_key
str

用于此 Web 服务的主身份验证密钥。

secondary_key
str

用于此 Web 服务的辅助身份验证密钥。

azureml.core.webservice.AksServiceDeploymentConfiguration.tags

要为此 Web 服务提供键值标记的字典。

azureml.core.webservice.AksServiceDeploymentConfiguration.properties

要为此 Web 服务提供键值属性的字典。 部署后无法更改这些属性,但可以添加新的键值对。

azureml.core.webservice.AksServiceDeploymentConfiguration.description

提供此 Web 服务的说明。

gpu_cores
int

要为此 Web 服务分配的 GPU 核心数。 默认值为 0。

period_seconds
int

执行运行情况探测的频率(秒)。 默认值为 10 秒。 最小值为 1。

initial_delay_seconds
int

启动生存情况探测之前容器启动后的秒数。 默认值为 310。

timeout_seconds
int

运行情况探测超时的秒数。默认值为 2 秒。 最小值为 1。

success_threshold
int

运行情况探测失败后,将其视为成功所需的最小连续成功次数。 默认值为 1。 最小值为 1。

failure_threshold
int

当 Pod 启动且运行情况探测失败时,Kubernetes 会在放弃之前尝试 failureThreshold 时间。 默认值为 3。 最小值为 1。

azureml.core.webservice.AksServiceDeploymentConfiguration.namespace

要在其中部署此 Web 服务的 Kubernetes 命名空间:最多 63 个小写字母数字('a'-'z'、'0'-'9')和连字符('-')字符。 第一个字符和最后一个字符不能是连字符。

token_auth_enabled

是否为此 Web 服务启用 Azure Active Directory 身份验证。 如果启用此功能,则用户可以使用其 Azure Active Directory 凭据提取访问令牌来访问此 Web 服务。 默认为 False。

方法

print_deploy_configuration

打印部署配置。

validate_configuration

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

如果验证失败,将引发 WebserviceException。

print_deploy_configuration

打印部署配置。

print_deploy_configuration()

validate_configuration

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

如果验证失败,将引发 WebserviceException。

validate_configuration()

例外

类型 说明