Image 类

定义 Azure 机器学习映像的抽象父类。

此类已弃用。请改用 Environment 类。

图像构造函数。

此类已弃用。请改用 Environment 类。

图像构造函数用于检索与提供的工作区关联的 Image 对象的云表示形式。将返回与检索的图像对象的特定类型对应的子类的实例。

构造函数

Image(workspace, name=None, id=None, tags=None, properties=None, version=None)

参数

名称	说明
workspace 必需	Workspace 包含要检索的图像的 Workspace 对象。
name	str 要检索的图像的名称。将返回映像的最新版本（如果存在）。默认值: None
id	str 要检索的图像的特定 ID。（ID 为“<name>：<version>”）默认值: None
tags	list 将按“key”或“[key， value]”根据提供的列表筛选图像结果。例如： ['key'， ['key2'， 'key2 value']] 默认值: None
properties	list 将按“key”或“[key， value]”根据提供的列表筛选图像结果。例如： ['key'， ['key2'， 'key2 value']] 默认值: None
version	str 当同时指定版本和名称时，将返回映像的特定版本。默认值: None
workspace 必需	Workspace 包含要检索的图像的工作区对象
name 必需	str 要检索的图像的名称。将返回最新版本（如果存在）
id 必需	str 要检索的图像的特定 ID。（ID 为“：”）
tags 必需	list 将按“key”或“[key， value]”根据提供的列表筛选图像结果。例如： ['key'， ['key2'， 'key2 value']]
properties 必需	list 将按“key”或“[key， value]”根据提供的列表筛选图像结果。例如： ['key'， ['key2'， 'key2 value']]
version 必需	str 当同时指定版本和名称时，将返回映像的特定版本。

注解

图像构造函数检索与提供的工作区关联的 Image 对象的云表示形式。它返回与检索的图像对象的特定类型对应的子类的实例。

Image 对象用于将用户Model部署为 .Webservice Image 对象通常包含模型、执行脚本和模型部署所需的任何依赖项。 Image 类具有多个子类，例如 Docker 映像的 ContainerImage 和 FPGA 等映像。

ContainerImage有关从 Image 类继承的类的示例，请参阅该类。

映像通常用于需要使用图像的工作流。对于大多数工作流，应改用 Environment 类来定义图像。然后，可以将 Environment 对象与方法结合使用 Modeldeploy() ，将模型部署为 Web 服务。还可以使用 Model package() 方法创建一个映像，该映像可以作为映像或 Dockerfile 下载到本地 Docker 安装。

有关在 Azure 中部署模型的概述，请参阅以下链接： https://aka.ms/azureml-how-deploy

方法

add_properties	向图像添加属性。
add_tags	向图像添加标记。
create	在提供的工作区中创建映像。
delete	从其相应的工作区中删除映像。
deserialize	将 json 对象转换为 Image 对象。
image_configuration	用于创建映像配置对象的抽象方法。
list	列出与相应工作区关联的映像。可以使用特定参数进行筛选。
remove_tags	从映像中删除标记。
serialize	将此 Image 对象转换为 JSON 序列化字典。
update	更新映像。
update_creation_state	刷新内存中对象的当前状态。根据相应云对象的当前状态对对象的属性进行就地更新。主要用于手动轮询创建状态。
wait_for_creation	等待映像完成创建。等待映像创建到达终端状态。如果 WebserviceException 达到非成功终端状态，将引发 WebserviceException。

add_properties

向图像添加属性。

add_properties(properties)

参数

名称	说明
properties 必需	dict[str, str] 要添加的属性字典。

例外

类型	说明
WebserviceException

add_tags

向图像添加标记。

add_tags(tags)

参数

名称	说明
tags 必需	dict[str, str] 要添加的标记字典。

例外

类型	说明
WebserviceException

create

在提供的工作区中创建映像。

static create(workspace, name, models, image_config)

参数

名称	说明
workspace 必需	<xref:<xref:workspace: azureml.core.workspace.Workspace>> 要与此映像关联的工作区。
name 必需	str 要与此映像关联的名称。
models 必需	list[Model] 要使用此映像打包的 Model 对象列表。可以是空列表。
image_config 必需	ImageConfig 用于配置此映像的映像配置对象。

类型	说明
Image	创建的 Image 对象。

例外

类型	说明
WebserviceException

delete

从其相应的工作区中删除映像。

delete()

例外

类型	说明
WebserviceException

注解

如果映像已部署到实时 Web 服务，此方法将失败。

deserialize

将 json 对象转换为 Image 对象。

deserialize(workspace, image_payload)

参数

名称	说明
cls 必需	指示类方法。
workspace 必需	Workspace 映像注册到的工作区对象。
image_payload 必需	dict 要转换为 Image 对象的 JSON 对象。

类型	说明
Image	提供的 JSON 对象的图像表示形式。

注解

如果提供的工作区不是映像在其下注册的工作区，则此方法将失败。

image_configuration

用于创建映像配置对象的抽象方法。

abstract static image_configuration()

list

列出与相应工作区关联的映像。可以使用特定参数进行筛选。

static list(workspace, image_name=None, model_name=None, model_id=None, tags=None, properties=None)

参数

名称	说明
workspace 必需	Workspace 要在其中列出图像的 Workspace 对象。
image_name	str 筛选列表以仅包含使用特定映像名称部署的映像。默认值: None
model_name	str 筛选列表以仅包含使用特定模型名称部署的映像。默认值: None
model_id	str 筛选列表以仅包含使用特定模型 ID 部署的映像。默认值: None
tags	list 将根据提供的列表（按“key”或“[key，value]”）进行筛选。例如： ['key'， ['key2'， 'key2 value']] 默认值: None
properties	list 将根据提供的列表（按“key”或“[key，value]”）进行筛选。例如： ['key'， ['key2'， 'key2 value']] 默认值: None

类型	说明
list[<xref:Images>]	提供的工作区中图像的筛选列表。

例外

类型	说明
WebserviceException

remove_tags

从映像中删除标记。

remove_tags(tags)

参数

名称	说明
tags 必需	list[str] 与要删除的标记对应的键列表。

例外

类型	说明
WebserviceException

serialize

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

serialize()

类型	说明
dict	此 Image 对象的 JSON 表示形式。

update

更新映像。

update(tags)

参数

名称	说明
tags 必需	dict[str, str] 用于更新映像的标记字典。将覆盖任何现有标记。

例外

类型	说明
WebserviceException

update_creation_state

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

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

update_creation_state()

例外

类型	说明
WebserviceException

wait_for_creation

等待映像完成创建。

等待映像创建到达终端状态。如果 WebserviceException 达到非成功终端状态，将引发 WebserviceException。

wait_for_creation(show_output=False)

参数

名称	说明
show_output	bool 用于打印更详细输出的布尔选项。默认为 False。默认值: False

例外

类型	说明
WebserviceException