Image 类
为 Azure 机器学习映像定义抽象父类。
此类已弃用。 请改用 Environment 类。
图像构造函数。
此类已弃用。 请改用 Environment 类。
图像构造函数用于检索与提供的工作区关联的 Image 对象的云表示形式。 将返回与检索的图像对象的特定类型对应的子类的实例。
- 继承
-
Image
构造函数
Image(workspace, name=None, id=None, tags=None, properties=None, version=None)参数
| 名称 | 说明 |
|---|---|
|
workspace
必需
|
包含要检索的映像的工作区对象。 |
|
name
|
要检索的映像的名称。 将返回最新版本的映像（如果存在）。 默认值: None
|
|
id
|
要检索的映像的特定 ID。 （ID 为“<名称>:<版本>”） 默认值: None
|
|
tags
|
将基于提供的列表按“key”或“[key, value]”筛选映像结果。 例如： ['key', ['key2', 'key2 value']] 默认值: None
|
|
properties
|
将基于提供的列表按“key”或“[key, value]”筛选映像结果。 例如： ['key', ['key2', 'key2 value']] 默认值: None
|
|
version
|
如果同时指定了版本和名称，则返回映像的特定版本。 默认值: None
|
|
workspace
必需
|
包含要检索的图像的工作区对象 |
|
name
必需
|
要检索的映像的名称。 将返回最新版本（如果存在） |
|
id
必需
|
要检索的映像的特定 ID。 （ID 为“：”） |
|
tags
必需
|
将基于提供的列表按“key”或“[key, value]”筛选映像结果。 例如： ['key', ['key2', 'key2 value']] |
|
properties
必需
|
将基于提供的列表按“key”或“[key, value]”筛选映像结果。 例如： ['key', ['key2', 'key2 value']] |
|
version
必需
|
如果同时指定了版本和名称，则返回映像的特定版本。 |
注解
Image 构造函数检索与提供的工作区关联的 Image 对象的云表示形式。 返回一个与检索到的特定类型的 Image 对象对应的子类实例。
Image 对象用于将用户的 Model 部署为 Webservice。 Image 对象通常包含模型、执行脚本和模型部署所需的任何依赖项。 Image 类有多个子类，例如用于 Docker 映像的 ContainerImage 和 FPGA 等映像。
有关继承自 Image 类的类的示例，请参阅 ContainerImage 类。
映像通常用于需要使用映像的工作流。 对于大多数工作流，应改用 Environment 类来定义映像。 然后，可以将 Environment 对象与方法结合使用Modeldeploy()，将模型部署为 Web 服务。
还可以使用模型 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 达到非成功终端状态，则会引发该异常。 |
add_properties
将属性添加到映像。
add_properties(properties)参数
| 名称 | 说明 |
|---|---|
|
properties
必需
|
要添加的属性字典。 |
例外
| 类型 | 说明 |
|---|---|
add_tags
create
在提供的工作区中创建映像。
static create(workspace, name, models, image_config)参数
| 名称 | 说明 |
|---|---|
|
workspace
必需
|
<xref:<xref:workspace: azureml.core.workspace.Workspace>>
要与此映像关联的工作区。 |
|
name
必需
|
要与此映像关联的名称。 |
|
models
必需
|
要与此映像一起打包的模型对象的列表。 可以是空列表。 |
|
image_config
必需
|
用于配置此映像的映像配置对象。 |
返回
| 类型 | 说明 |
|---|---|
|
创建的 Image 对象。 |
例外
| 类型 | 说明 |
|---|---|
delete
deserialize
将 JSON 对象转换为 Image 对象。
deserialize(workspace, image_payload)参数
| 名称 | 说明 |
|---|---|
|
cls
必需
|
指示类方法。 |
|
workspace
必需
|
映像注册到的工作区对象。 |
|
image_payload
必需
|
要转换为 Image 对象的 JSON 对象。 |
返回
| 类型 | 说明 |
|---|---|
|
所提供的 JSON 对象的 Image 表示形式。 |
例外
| 类型 | 说明 |
|---|---|
注解
如果提供的工作区不是注册映像的工作区，则此方法会失败。
image_configuration
list
列出与相应工作区关联的映像。 可以使用特定参数进行筛选。
static list(workspace, image_name=None, model_name=None, model_id=None, tags=None, properties=None)参数
| 名称 | 说明 |
|---|---|
|
workspace
必需
|
要列出其中的映像的工作区对象。 |
|
image_name
|
筛选列表，仅包含使用特定映像名称部署的映像。 默认值: None
|
|
model_name
|
筛选列表，仅包含使用特定模型名称部署的映像。 默认值: None
|
|
model_id
|
筛选列表，仅包含使用特定模型 ID 部署的映像。 默认值: None
|
|
tags
|
将基于提供的列表按“key”或“[key, value]”筛选。 例如： ['key', ['key2', 'key2 value']] 默认值: None
|
|
properties
|
将基于提供的列表按“key”或“[key, value]”筛选。 例如： ['key', ['key2', 'key2 value']] 默认值: None
|
返回
| 类型 | 说明 |
|---|---|
|
list[<xref:Images>]
|
提供的工作区中已筛选的映像列表。 |
例外
| 类型 | 说明 |
|---|---|
remove_tags
serialize
将此 Image 对象转换为 JSON 序列化字典。
serialize()返回
| 类型 | 说明 |
|---|---|
|
此 Image 对象的 JSON 表示形式。 |
例外
| 类型 | 说明 |
|---|---|
update
更新映像。
update(tags)参数
| 名称 | 说明 |
|---|---|
|
tags
必需
|
用于更新映像的标记字典。 将覆盖任何现有标记。 |
例外
| 类型 | 说明 |
|---|---|
update_creation_state
刷新内存中对象的当前状态。
根据对象的相应云对象的当前状态，对对象的属性执行就地更新。 主要用于创建状态的手动轮询。
update_creation_state()例外
| 类型 | 说明 |
|---|---|
wait_for_creation
等待映像创建完成。
等待映像创建进入终端状态。 如果 WebserviceException 达到非成功终端状态，则会引发该异常。
wait_for_creation(show_output=False)参数
| 名称 | 说明 |
|---|---|
|
show_output
|
用于列显更详细输出的布尔选项。 默认为 False。 默认值: False
|
例外
| 类型 | 说明 |
|---|---|