LocalWebservice 类

  • 参考

表示部署为本地 Web 服务终结点的机器学习模型。

在本地部署 Web 服务对于调试和测试方案非常有用。

本地 Webservice 构造函数。

LocalWebservice 构造函数用于检索与提供的工作区关联的 LocalWebservice 对象的本地表示形式。

继承
Webservice
LocalWebservice

构造函数

LocalWebservice(*args, **kwargs)

参数

workspace
Workspace
必需

包含要检索的任何模型对象的工作区对象。

name
str
必需

要检索的 Webservice 对象的名称。

must_exist
bool
必需

创建内存中对象时 webservice 是否必须已存在。

workspace
Workspace
必需

包含要检索的任何模型对象的工作区对象。

name
str
必需

要检索的 LocalWebservice 对象的名称。

must_exist
bool
必需

创建内存中对象时 webservice 是否必须已存在。

注解

以下代码示例演示如何创建本地 Docker Web 服务。 有关更多详细信息，请参阅笔记本链接。


   from azureml.core.webservice import LocalWebservice

   # This is optional, if not provided Docker will choose a random unused port.
   deployment_config = LocalWebservice.deploy_configuration(port=6789)

   local_service = Model.deploy(ws, "test", [model], inference_config, deployment_config)

   local_service.wait_for_deployment()

完整示例可从 https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb 获取

方法

delete

从本地计算机中删除此 LocalWebservice。

此函数调用不是异步的；它会运行到删除了服务为止。
deploy_configuration

创建用于部署本地 Webservice 的配置对象。
deploy_to_cloud

根据 LocalWebservice 的配置部署 Webservice。
deserialize

将模型管理服务响应 JSON 对象转换为 Webservice 对象。

注意

不受 LocalWebservice 的支持。
get_keys

检索此 Webservice 的身份验证密钥。

注意

不受 LocalWebservice 的支持。
get_logs

检索此 LocalWebservice 的日志。
get_token

检索此 Webservice 的身份验证令牌，范围为当前用户。

注意

不受 LocalWebservice 的支持。
list

列出与相应工作区关联的 LocalWebservice。

可以使用参数筛选返回的结果。
regen_key

重新生成 Webservice 的一个密钥。

注意

不受 LocalWebservice 的支持。
reload

重新加载 LocalWebservice 的执行脚本和依赖项。

这将使用已更新资产的副本（包括执行脚本和本地依赖项）重启服务的容器，但不重新生成基础映像。 因此，对 Conda/pip 依赖项或自定义 Docker 步骤所做的更改不会反映在重新加载的 LocalWebservice 中。 若要处理这些更改，请改为调用 update 方法。
run

使用提供的输入调用此 LocalWebservice。
serialize

将此 Webservice 对象转换为 JSON 序列化字典。
update

使用提供的属性更新 LocalWebservice。

在此 LocalWebservice 中，保留为 None 的值将保持不变。
update_deployment_state

刷新内存中对象的当前状态。

根据相应本地 Docker 容器的当前状态，对对象的属性执行就地更新。
wait_for_deployment

轮询正在运行的 LocalWebservice 部署。

delete

从本地计算机中删除此 LocalWebservice。

此函数调用不是异步的；它会运行到删除了服务为止。

delete(delete_cache=True, delete_image=False, delete_volume=True)

参数

delete_cache
bool
必需

是否删除为服务缓存的临时文件。 （默认值：True）

delete_image
bool
必需

是否删除服务的 Docker 映像。 （默认值：False）

delete_volume
bool
必需

是否删除服务的 Docker 卷。 （默认值：True）

例外

WebserviceException

deploy_configuration

创建用于部署本地 Webservice 的配置对象。

static deploy_configuration(port=None)

参数

port
int
默认值: None

用于公开服务的 HTTP 终结点的本地端口。

返回

部署 Webservice 对象时要使用的配置对象。

返回类型

LocalWebserviceDeploymentConfiguration

例外

WebserviceException

deploy_to_cloud

根据 LocalWebservice 的配置部署 Webservice。

deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)

参数

name
str
默认值: None

为部署的服务指定的名称。 对工作区必须是唯一的。

deployment_config
WebserviceDeploymentConfiguration
默认值: None

用于配置 webservice 的 WebserviceDeploymentConfiguration。 如果未提供，将基于所需目标使用空配置对象。

deployment_target
ComputeTarget
默认值: None

要将 Webservice 部署到的 ComputeTarget。 由于 ACI 没有关联 ComputeTarget，因此将此参数保留为 None 以部署到 ACI。

返回

对应于已部署的 webservice 的 webservice 对象。

返回类型

Webservice

例外

WebserviceException

deserialize

将模型管理服务响应 JSON 对象转换为 Webservice 对象。

注意

不受 LocalWebservice 的支持。

deserialize(workspace, webservice_payload)

参数

cls
必需
workspace
Workspace
必需

Webservice 注册到的工作区对象。

webservice_payload
dict
必需

要转换为 Webservice 对象的 JSON 对象。

例外

azureml.exceptions.NotImplementedError

get_keys

检索此 Webservice 的身份验证密钥。

注意

不受 LocalWebservice 的支持。

get_keys()

返回

此 Webservice 的身份验证密钥。

例外

azureml.exceptions.NotImplementedError

get_logs

检索此 LocalWebservice 的日志。

get_logs(num_lines=5000, raw=False)

参数

num_lines
int
必需

要检索的最大日志行数。 （默认值：5000）

raw
bool
必需

返回原始 Docker 容器输出，但不尝试设置其格式。 （默认值：False）

返回

此 LocalWebservice 的日志。

返回类型

str

例外

WebserviceException

get_token

检索此 Webservice 的身份验证令牌，范围为当前用户。

注意

不受 LocalWebservice 的支持。

get_token()

返回

此 Webservice 的身份验证令牌，以及应该刷新此令牌的时间。

返回类型

str, datetime

例外

azureml.exceptions.NotImplementedError

list

列出与相应工作区关联的 LocalWebservice。

可以使用参数筛选返回的结果。

static list(workspace, model_name=None, model_id=None, all=None)

参数

workspace
Workspace
必需

与 LocalWebservice 关联的工作区对象。

model_name
str
默认值: None

筛选列表，仅包含使用特定模型名称部署的 LocalWebservice。

model_id
str
默认值: None

筛选列表，仅包含使用特定模型 ID 部署的 LocalWebservice。

all
bool
默认值: None

显示所有服务。 默认情况下，仅显示运行中的服务。

返回

筛选出的与提供的工作区关联的 LocalWebservice 的列表。

返回类型

list[LocalWebservice]

例外

WebserviceException

regen_key

重新生成 Webservice 的一个密钥。

注意

不受 LocalWebservice 的支持。

regen_key(key)

参数

key
str
必需

要重新生成的密钥。 选项为“Primary”或“Secondary”

例外

NotImplementedError

reload

重新加载 LocalWebservice 的执行脚本和依赖项。

这将使用已更新资产的副本（包括执行脚本和本地依赖项）重启服务的容器，但不重新生成基础映像。 因此，对 Conda/pip 依赖项或自定义 Docker 步骤所做的更改不会反映在重新加载的 LocalWebservice 中。 若要处理这些更改，请改为调用 update 方法。

reload(wait=False)

参数

wait
bool
必需

等待服务的容器达到正常状态。 （默认值：False）

例外

WebserviceException

run

使用提供的输入调用此 LocalWebservice。

run(input_data)

参数

input_data
<xref:varies>
必需

用于调用 LocalWebservice 的输入。

返回

调用 LocalWebservice 后的结果。

返回类型

<xref:varies>

例外

WebserviceException

serialize

将此 Webservice 对象转换为 JSON 序列化字典。

serialize()

返回

Webservice 对象的序列化表示形式。

返回类型

dict

例外

WebserviceException

update

使用提供的属性更新 LocalWebservice。

在此 LocalWebservice 中，保留为 None 的值将保持不变。

update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)

参数

models
list[Model]
必需

LocalWebservice 中包含的模型的新列表。

image_config
ContainerImageConfig
必需

应用于 LocalWebservice 的映像配置选项。

deployment_config
LocalWebserviceDeploymentConfiguration
必需

应用于 LocalWebservice 的部署配置选项。

inference_config
InferenceConfig
必需

用于提供所需模型部署属性的 InferenceConfig 对象。

wait
bool
必需

等待服务的容器达到正常状态。 （默认值：False）

返回类型

None

例外

WebserviceException

update_deployment_state

刷新内存中对象的当前状态。

根据相应本地 Docker 容器的当前状态，对对象的属性执行就地更新。

update_deployment_state(must_exist=False)

参数

must_exist
bool
默认值: False

创建内存中对象时 webservice 是否必须已存在。

例外

WebserviceException

wait_for_deployment

轮询正在运行的 LocalWebservice 部署。

wait_for_deployment(show_output=False)

参数

show_output
bool
必需

用于显示更详细输出的选项。 （默认值：False）

例外

WebserviceException

属性

port

获取本地 webservice 端口。

返回

端口号。

返回类型

int

scoring_uri

获取本地 webservice 评分 URI。

返回

评分 URI。

返回类型

str

swagger_uri

获取本地 webservice Swagger URI。

返回

Swagger URI。

返回类型

str

NETWORK_NAME 

NETWORK_NAME = 'azureml-local'

STATE_DELETED 

STATE_DELETED = 'deleted'

STATE_DEPLOYING 

STATE_DEPLOYING = 'deploying'

STATE_FAILED 

STATE_FAILED = 'failed'

STATE_RUNNING 

STATE_RUNNING = 'running'

STATE_UNKNOWN 

STATE_UNKNOWN = 'unknown'