ModelPackage 类

参考

表示将一个或多个模型及其依赖项打包到 Docker 映像或 Dockerfile 中。

ModelPackage 对象从 Model 类的 package 方法返回。打包方法的 generate_dockerfile 参数确定是创建 Docker 映像还是创建 Dockerfile。

初始化使用模型创建的包 () 和依赖项。

继承: builtins.object

ModelPackage

构造函数

ModelPackage(workspace, operation_id, environment)

参数

名称	说明
workspace 必需	Workspace 包所在的工作区。
operation_id 必需	str 包创建操作的 ID。
environment 必需	Environment 正在打包模型的环境。
workspace 必需	Workspace 包所在的工作区。
operation_id 必需	str 包创建操作的 ID。
environment 必需	Environment 正在打包模型的环境。

注解

若要生成封装模型及其依赖项的 Docker 映像，可以使用模型打包选项。输出映像将推送到工作区的 ACR。

若要使用模型包方法，则推理配置中必须包括 Environment 对象。


   package = Model.package(ws, [model], inference_config)
   package.wait_for_creation(show_output=True)  # Or show_output=False to hide the Docker build logs.
   package.pull()

可改为生成 Dockerfile，并下载在 Environment 上生成映像所需的所有资产，而不是完全生成映像。


   package = Model.package(ws, [model], inference_config, generate_dockerfile=True)
   package.wait_for_creation(show_output=True)
   package.save("./local_context_dir")

变量

名称	说明
azureml.core.model.ModelPackage.workspace	创建包的工作区。

方法

get_container_registry	返回一个 ContainerRegistry 对象，该对象指示映像或基础映像（Dockerfile 包）的存储位置。
get_logs	检索包创建日志。
pull	将包输出拉取到本地计算机。这只能与 Docker 映像包一起使用。
save	将包输出保存到本地目录。这只能与 Dockerfile 包一起使用。
serialize	将此 ModelPackage 转换为 JSON 可序列化字典，以供 CLI 显示。
update_creation_state	刷新内存中对象的当前状态。此方法根据相应云对象的当前状态就地更新对象属性。这主要用于手动轮询创建状态。
wait_for_creation	等待包创建完成。此方法等待包创建达到终端状态。如果未达到成功的终端状态，将引发 WebserviceException。

get_container_registry

返回一个 ContainerRegistry 对象，该对象指示映像或基础映像（Dockerfile 包）的存储位置。

get_container_registry()

类型	说明
ContainerRegistry	容器注册表的地址和登录凭据。

get_logs

检索包创建日志。

get_logs(decode=True, offset=0)

参数

名称	说明
decode	bool 指示是否将原始日志字节解码为字符串。默认值: True
offset	int 从其开始读取日志的字节偏移量。默认值: 0

类型	说明
bytes, str	包创建日志。

例外

类型	说明
WebserviceException

pull

将包输出拉取到本地计算机。

这只能与 Docker 映像包一起使用。

pull()

例外

类型	说明
WebserviceException

save

将包输出保存到本地目录。

这只能与 Dockerfile 包一起使用。

save(output_directory)

参数

名称	说明
output_directory 必需	str 即将创建的本地目录，用于容纳包的内容。

例外

类型	说明
WebserviceException

serialize

将此 ModelPackage 转换为 JSON 可序列化字典，以供 CLI 显示。

serialize()

类型	说明
dict	此 ModelPackage 的 JSON 表示形式。

update_creation_state

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

此方法根据相应云对象的当前状态就地更新对象属性。这主要用于手动轮询创建状态。

update_creation_state()

例外

类型	说明
WebserviceException

wait_for_creation

等待包创建完成。

此方法等待包创建达到终端状态。如果未达到成功的终端状态，将引发 WebserviceException。

wait_for_creation(show_output=False)

参数

名称	说明
show_output	bool 指示是否打印更详细的输出。默认值: False

例外

类型	说明
WebserviceException

通过