共用方式為

ComputeInstance 類別

  • 參考

管理 Azure Machine Learning 中的雲端式優化 ML 開發環境。

Azure Machine Learning 計算實例是雲端中完全設定且受控的開發環境，已針對機器學習開發工作流程進行優化。 ComputeInstance 通常用來建立開發環境，或做為用於開發和測試之定型和推斷的計算目標。 透過 ComputeInstance，您可以在工作區中完全整合的筆記本體驗中撰寫、定型和部署模型。 如需詳細資訊，請參閱什麼是 Azure Machine Learning 計算執行個體？。

類別 ComputeTarget 建構函式。

擷取與所提供工作區相關聯的 Compute 物件的雲端標記法。 傳回對應至所擷取之 Compute 物件之特定類型的子類別實例。

繼承
ComputeTarget
ComputeInstance

建構函式

ComputeInstance(workspace, name)

參數

名稱 Description
workspace
必要
Workspace

包含要擷取之 Compute 物件的工作區物件。
name
必要
str

要擷取之 Compute 物件的 名稱。

方法

delete

從其相關聯的工作區中移除 ComputeInstance 物件。
deserialize

將 JSON 物件轉換成 ComputeInstance 物件。

如果提供的工作區不是 ComputeInstance 相關聯的工作區，就會失敗。
detach

ComputeInstance 物件不支援卸離。 請改用 delete。
get

傳回 ComputeInstance 物件。
get_active_runs

傳回這個計算的執行產生器。
get_docs_url

此類別的檔 URL。
get_status

擷取 ComputeInstance 的目前詳細狀態。
provisioning_configuration

建立用於布建 ComputeInstance 目標的組態物件。
refresh_state

執行 物件的屬性就地更新。

這個方法會根據對應雲端物件的目前狀態來更新屬性。 這主要用於手動輪詢計算狀態。
restart

重新開機 ComputeInstance。
serialize

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

啟動 ComputeInstance。
stop

停止 ComputeInstance。
supported_vmsizes

列出區域中支援的 VM 大小。
wait_for_completion

等候 ComputeInstance 完成布建。

delete

從其相關聯的工作區中移除 ComputeInstance 物件。

delete(wait_for_completion=False, show_output=False)

參數

名稱 Description
wait_for_completion
預設值: False
show_output
預設值: False

例外狀況

類型 Description
ComputeTargetException

備註

如果此物件是透過 Azure ML 建立的，也會刪除對應的雲端式物件。 如果此物件是在外部建立，且只附加至工作區，則會引發例外狀況，而且不會變更任何專案。

deserialize

將 JSON 物件轉換成 ComputeInstance 物件。

如果提供的工作區不是 ComputeInstance 相關聯的工作區，就會失敗。

static deserialize(workspace, object_dict)

參數

名稱 Description
workspace
必要
Workspace

ComputeInstance 物件的工作區物件與 相關聯。
object_dict
必要
dict

要轉換成 ComputeInstance 物件的 JSON 物件。

傳回

類型 Description
ComputeInstance

所提供 JSON 物件的 ComputeInstance 標記法。

例外狀況

類型 Description
ComputeTargetException

detach

ComputeInstance 物件不支援卸離。 請改用 delete。

detach()

例外狀況

類型 Description
ComputeTargetException

作業不會進行更新。

get

傳回 ComputeInstance 物件。

get()

傳回

類型 Description
ComputeInstance

所提供 JSON 物件的 ComputeInstance 標記法。

例外狀況

類型 Description
ComputeTargetException

get_active_runs

傳回這個計算的執行產生器。

get_active_runs(type=None, tags=None, properties=None, status=None)

參數

名稱 Description
type
str

依提供的型別篩選所傳回的執行產生器。 請參閱 add_type_provider 以建立執行類型。

預設值: None
tags
str 或 dict

依 「tag」 或 {「tag」： 「value」} 篩選執行

預設值: None
properties
str 或 dict

篩選會依 「property」 或 {「property」： 「value」} 執行

預設值: None
status
str

執行狀態可以是「執行中」或「已排入佇列」。

預設值: None

傳回

類型 Description
<xref:builtin.generator>

azureml._restclient.models.RunDto 的產生器

例外狀況

類型 Description
ComputeTargetException

get_docs_url

此類別的檔 URL。

get_docs_url()

傳回

類型 Description
str

url

例外狀況

類型 Description
ComputeTargetException

get_status

擷取 ComputeInstance 的目前詳細狀態。

get_status()

傳回

類型 Description
ComputeInstanceStatus

計算的詳細狀態物件

例外狀況

類型 Description
ComputeTargetException

provisioning_configuration

建立用於布建 ComputeInstance 目標的組態物件。

static provisioning_configuration(vm_size='', ssh_public_access=False, admin_user_ssh_public_key=None, vnet_resourcegroup_name=None, vnet_name=None, subnet_name=None, tags=None, description=None, assigned_user_object_id=None, assigned_user_tenant_id=None)

參數

名稱 Description
vm_size
必要
str

代理程式 VM 的大小。 您可以在這裡找到更多詳細資料： https://aka.ms/azureml-vm-details 。 請注意，並非所有大小都可在所有區域中使用，如上一個連結中所述。 預設為 Standard_NC6。
ssh_public_access
bool

指出公用 SSH 埠的狀態。 可能的值包括：

  • False - 公用 SSH 埠已關閉。
  • True - 公用 SSH 埠已開啟。
預設值: False
admin_user_ssh_public_key
str

管理員使用者帳戶的 SSH 公開金鑰。

預設值: None
vnet_resourcegroup_name
str

虛擬網路所在的資源組名。

預設值: None
vnet_name
str

虛擬網路的名稱。

預設值: None
subnet_name
str

vnet 內子網的名稱。

預設值: None
tags
dict[str, str]

要與計算物件產生關聯的索引鍵值標記選擇性字典。

預設值: None
description
str

計算物件的選擇性描述。

預設值: None
assigned_user_object_id
str

指派之使用者 (預覽) 的 AAD 物件識別碼。

預設值: None
assigned_user_tenant_id
str

指派之使用者的 AAD 租使用者識別碼 (預覽) 。

預設值: None

傳回

類型 Description
ComputeInstanceProvisioningConfiguration

建立 Compute 物件時要使用的組態物件。

例外狀況

類型 Description
ComputeTargetException

refresh_state

執行 物件的屬性就地更新。

這個方法會根據對應雲端物件的目前狀態來更新屬性。 這主要用於手動輪詢計算狀態。

refresh_state()

例外狀況

類型 Description
ComputeTargetException

restart

重新開機 ComputeInstance。

restart(wait_for_completion=False, show_output=False)

參數

名稱 Description
wait_for_completion
bool

布林值等候狀態更新。 預設為 False。

預設值: False
show_output
bool

布林值以提供更詳細的輸出。 預設為 False。

預設值: False

傳回

類型 Description
None

無

例外狀況

類型 Description
azureml.exceptions.ComputeTargetException:

serialize

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

serialize()

傳回

類型 Description
dict

這個 ComputeInstance 物件的 JSON 表示。

例外狀況

類型 Description
ComputeTargetException

start

啟動 ComputeInstance。

start(wait_for_completion=False, show_output=False)

參數

名稱 Description
wait_for_completion
bool

是否要等候狀態更新。 預設為 False。

預設值: False
show_output
bool

是否要提供更詳細的輸出。 預設為 False。

預設值: False

傳回

類型 Description
None

無

例外狀況

類型 Description
ComputeTargetException

stop

停止 ComputeInstance。

stop(wait_for_completion=False, show_output=False)

參數

名稱 Description
wait_for_completion
bool

是否要等候狀態更新。 預設為 False。

預設值: False
show_output
bool

是否要提供更詳細的輸出。 預設為 False。

預設值: False

傳回

類型 Description
None

無

例外狀況

類型 Description
ComputeTargetException

supported_vmsizes

列出區域中支援的 VM 大小。

static supported_vmsizes(workspace, location=None)

參數

名稱 Description
workspace
必要
Workspace

工作區。
location
str

實例的位置。 如果未指定，預設值為工作區位置。

預設值: None

傳回

類型 Description
list

區域中支援的 VM 大小清單，其中包含 VM、VCPU 和 RAM 的名稱。

例外狀況

類型 Description
ComputeTargetException

wait_for_completion

等候 ComputeInstance 完成布建。

wait_for_completion(show_output=False, is_delete_operation=False)

參數

名稱 Description
show_output
bool

是否要提供更詳細的輸出。 預設為 False。

預設值: False
is_delete_operation
bool

指出作業是否要刪除。

預設值: False

例外狀況

類型 Description
ComputeTargetException