Image 类

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

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

映像构造函数。

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

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

继承

ABC

Image

构造函数

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

参数

workspace

Workspace

必需

包含要检索的映像的工作区对象。

name

str

默认值: None

要检索的映像的名称。 将返回最新版本的映像（如果存在）。

id

str

默认值: None

要检索的映像的特定 ID。 （ID 为“<名称>:<版本>”）

tags

list

默认值: None

将基于提供的列表按“key”或“[key, value]”筛选映像结果。 例如： ['key', ['key2', 'key2 value']]

properties

list

默认值: None

将基于提供的列表按“key”或“[key, value]”筛选映像结果。 例如： ['key', ['key2', 'key2 value']]

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

必需

如果同时指定了版本和名称，则返回映像的特定版本。

注解

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

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

有关继承自映像类的类的示例，请参阅 ContainerImage 类。

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

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

方法

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

必需

要与此映像一起打包的模型对象的列表。 可以是空列表。

image_config

ImageConfig

必需

用于配置此映像的映像配置对象。

返回

创建的映像对象。

返回类型

Image

例外

WebserviceException

delete

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

delete()

例外

WebserviceException

注解

如果映像已部署到实时 webservice，则此方法失败。

deserialize

将 json 对象转换为映像对象。

deserialize(workspace, image_payload)

参数

cls

必需

指示类方法。

workspace

Workspace

必需

映像注册到的工作区对象。

image_payload

dict

必需

要转换为映像对象的 JSON 对象。

返回

所提供的 JSON 对象的映像表示形式。

返回类型

Image

例外

WebserviceException

注解

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

image_configuration

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

abstract static image_configuration()

例外

WebserviceException

list

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

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

参数

workspace

Workspace

必需

要列出映像的工作区对象。

image_name

str

默认值: None

筛选列表，仅包含使用特定映像名称部署的映像。

model_name

str

默认值: None

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

model_id

str

默认值: None

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

tags

list

默认值: None

基于提供的列表按“key”或“[key, value]”筛选。 例如： ['key', ['key2', 'key2 value']]

properties

list

默认值: None

基于提供的列表按“key”或“[key, value]”筛选。 例如： ['key', ['key2', 'key2 value']]

返回

提供的工作区中已筛选的映像的列表。

返回类型

list[<xref:Images>]

例外

WebserviceException

remove_tags

从映像中删除标记。

remove_tags(tags)

参数

tags

list[str]

必需

与要删除的标记对应的键列表。

例外

WebserviceException

serialize

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

serialize()

返回

此映像对象的 JSON 表示形式。

返回类型

dict

例外

WebserviceException

update

更新映像。

update(tags)

参数

tags

dict[str, str]

必需

用于更新映像的标记字典。 将覆盖任何现有标记。

例外

WebserviceException

update_creation_state

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

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

update_creation_state()

例外

WebserviceException

wait_for_creation

等待映像创建完成。

等待映像创建进入终端状态。 如果 WebserviceException 达到非成功终端状态，则会引发该异常。

wait_for_creation(show_output=False)

参数

show_output

bool

默认值: False

用于打印更详细输出的布尔选项。 默认为 False。

例外

WebserviceException