Image 類別
定義 Azure 機器學習 Images 的抽象父類別。
這個類別已被取代。 請改用 Environment 類別。
影像建構函式。
這個類別已被取代。 請改用 Environment 類別。
影像建構函式是用來擷取與所提供工作區相關聯之 Image 物件的雲端表示法。 會傳回對應至所擷取 Image 物件之特定型別之子類別的實例。
- 繼承
-
Image
建構函式
Image(workspace, name=None, id=None, tags=None, properties=None, version=None)參數
| 名稱 | Description |
|---|---|
|
workspace
必要
|
包含要擷取之 Image 的 Workspace 物件。 |
|
name
|
要擷取的 Image 名稱。 如果映像存在，則會傳回最新版本的映像。 預設值: None
|
|
id
|
要擷取之映像的特定標識碼。 （標識符為 “<name>：<version>”） 預設值: None
|
|
tags
|
會根據提供的清單篩選影像結果，方法是 'key' 或 '[key， value]'。 例如 ['key'， ['key2'， 'key2 value']] 預設值: None
|
|
properties
|
會根據提供的清單篩選影像結果，方法是 'key' 或 '[key， value]'。 例如 ['key'， ['key2'， 'key2 value']] 預設值: None
|
|
version
|
當同時指定版本和名稱時，將會傳回映像的特定版本。 預設值: None
|
|
workspace
必要
|
包含要擷取之 Image 的工作區物件 |
|
name
必要
|
要擷取的 Image 名稱。 如果存在，則會傳回最新版本 |
|
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 物件搭配 Model deploy() 方法，將模型部署為 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)參數
| 名稱 | Description |
|---|---|
|
properties
必要
|
要加入之屬性的字典。 |
例外狀況
| 類型 | Description |
|---|---|
add_tags
將標籤新增至影像。
add_tags(tags)參數
| 名稱 | Description |
|---|---|
|
tags
必要
|
要加入的標籤典。 |
例外狀況
| 類型 | Description |
|---|---|
create
在提供的工作區中建立映像。
static create(workspace, name, models, image_config)參數
| 名稱 | Description |
|---|---|
|
workspace
必要
|
<xref:<xref:workspace: azureml.core.workspace.Workspace>>
要與此映像建立關聯的工作區。 |
|
name
必要
|
要與此影像產生關聯的名稱。 |
|
models
必要
|
要使用此映像封裝的 Model 物件清單。 可以是空白清單。 |
|
image_config
必要
|
用來設定此映像的映像組態物件。 |
傳回
| 類型 | Description |
|---|---|
|
建立的 Image 物件。 |
例外狀況
| 類型 | Description |
|---|---|
delete
deserialize
將 json 物件轉換成 Image 物件。
deserialize(workspace, image_payload)參數
| 名稱 | Description |
|---|---|
|
cls
必要
|
表示類別方法。 |
|
workspace
必要
|
映射註冊的工作區物件。 |
|
image_payload
必要
|
要轉換成 Image 物件的 JSON 物件。 |
傳回
| 類型 | Description |
|---|---|
|
所提供 JSON 物件的影像表示。 |
例外狀況
| 類型 | Description |
|---|---|
備註
如果提供的工作區不是映像所註冊的工作區，這個方法就會失敗。
image_configuration
list
列出與對應工作區相關聯的影像。 可以使用特定參數進行篩選。
static list(workspace, image_name=None, model_name=None, model_id=None, tags=None, properties=None)參數
| 名稱 | Description |
|---|---|
|
workspace
必要
|
要列出影像的 Workspace 物件。 |
|
image_name
|
篩選清單，只包含以特定映射名稱部署的映像。 預設值: None
|
|
model_name
|
篩選清單，只包含以特定模型名稱部署的映像。 預設值: None
|
|
model_id
|
篩選清單，只包含以特定模型標識碼部署的映像。 預設值: None
|
|
tags
|
會根據提供的清單，依 'key' 或 '[key， value]' 進行篩選。 例如 ['key'， ['key2'， 'key2 value']] 預設值: None
|
|
properties
|
會根據提供的清單，依 'key' 或 '[key， value]' 進行篩選。 例如 ['key'， ['key2'， 'key2 value']] 預設值: None
|
傳回
| 類型 | Description |
|---|---|
|
list[<xref:Images>]
|
所提供工作區中影像的篩選清單。 |
例外狀況
| 類型 | Description |
|---|---|
remove_tags
從映像中移除標籤。
remove_tags(tags)參數
| 名稱 | Description |
|---|---|
|
tags
必要
|
對應至要移除標記的索引鍵清單。 |
例外狀況
| 類型 | Description |
|---|---|
serialize
將此 Image 物件轉換成 JSON 串行化字典。
serialize()傳回
| 類型 | Description |
|---|---|
|
這個 Image 物件的 JSON 表示法。 |
例外狀況
| 類型 | Description |
|---|---|
update
更新映像。
update(tags)參數
| 名稱 | Description |
|---|---|
|
tags
必要
|
要用來更新映像的標籤典。 將會覆寫任何現有的標記。 |
例外狀況
| 類型 | Description |
|---|---|
update_creation_state
重新整理記憶體內部物件的目前狀態。
根據對應雲端物件的目前狀態，執行對象的屬性就地更新。 主要用於手動輪詢建立狀態。
update_creation_state()例外狀況
| 類型 | Description |
|---|---|
wait_for_creation
等候映像完成建立。
等候映像建立到達終端機狀態。 如果 WebserviceException 達到非成功的終端狀態，則會擲回 WebserviceException。
wait_for_creation(show_output=False)參數
| 名稱 | Description |
|---|---|
|
show_output
|
布爾值選項可列印更詳細的輸出。 預設為 False。 預設值: False
|
例外狀況
| 類型 | Description |
|---|---|