Image 類別

  • 參考

定義 Azure Machine Learning 映射的抽象父類別。

這個類別已被取代。 請改用 Environment 類別。

映射建構函式。

這個類別已被取代。 請改用 Environment 類別。

影像建構函式可用來擷取與所提供工作區相關聯之 Image 物件的雲端標記法。 會傳回對應至所擷取之 Image 物件之特定類型的子類別實例。

繼承
ABC
Image

建構函式

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

參數

workspace
Workspace
必要

包含要擷取之 Image 的 Workspace 物件。

name
str
預設值: None

要擷取的 Image 名稱。 如果映射存在，則會傳回最新版本的映射。

id
str
預設值: None

要擷取之影像的特定識別碼。 (識別碼為 「 < name > ： < version > 」)

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
必要

包含要擷取之 Image 的工作區物件

name
str
必要

要擷取的 Image 名稱。 如果存在，則會傳回最新版本

id
str
必要

要擷取之影像的特定識別碼。 (識別碼為 「：」)

tags
list
必要

會依據提供的清單篩選影像結果，方法是 'key' 或 '[key， value]'。 例如 ['key'， ['key2'， 'key2 value']]

properties
list
必要

會依據提供的清單篩選影像結果，方法是 'key' 或 '[key， value]'。 例如 ['key'， ['key2'， 'key2 value']]

version
str
必要

同時指定版本和名稱時，將會傳回映射的特定版本。

備註

Image 建構函式會擷取與所提供工作區相關聯的 Image 物件的雲端標記法。 它會傳回對應至所擷取 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 物件。

傳回

所提供 JSON 物件的 Image 表示。

傳回類型

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
必要

要列出影像的 Workspace 物件。

image_name
str
預設值: None

篩選清單，只包含以特定映射名稱部署的映射。

model_name
str
預設值: None

篩選清單，只包含以特定模型名稱部署的映射。

model_id
str
預設值: None

篩選清單，只包含以特定模型識別碼部署的映射。

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

將此 Image 物件轉換成 JSON 序列化字典。

serialize()

傳回

這個 Image 物件的 JSON 標記法。

傳回類型

dict

例外狀況

WebserviceException

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