ComputeInstance 类

在 Azure 机器学习中管理基于云的优化 ML 开发环境。

Azure 机器学习计算实例是云中完全配置的托管开发环境，已针对机器学习开发工作流进行优化。 ComputeInstance 通常用于创建开发环境，或用作开发和测试训练和推理的计算目标。借助 ComputeInstance，可以在工作区的完全集成笔记本体验中创作、训练和部署模型。有关详细信息，请参阅什么是 Azure 机器学习计算实例？。

类 ComputeTarget 构造函数。

检索与提供的工作区关联的计算对象的云表示形式。返回与检索的计算对象的特定类型对应的子类的实例。

构造函数

ComputeInstance(workspace, name)

参数

名称	说明
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 大小。
update_sso_settings	更新计算实例的单一登录设置。
wait_for_completion	等待 ComputeInstance 完成预配。

delete

从其关联的工作区中删除 ComputeInstance 对象。

delete(wait_for_completion=False, show_output=False)

参数

名称	说明
wait_for_completion	默认值: False
show_output	默认值: False

例外

类型	说明
ComputeTargetException

注解

如果此对象是通过 Azure ML 创建的，则也会删除相应的基于云的对象。如果此对象是在外部创建的，并且仅附加到工作区，则会引发异常，且不会更改任何内容。

deserialize

将 JSON 对象转换为 ComputeInstance 对象。

如果提供的工作区不是 ComputeInstance 与之关联的工作区，则此作将失败。

static deserialize(workspace, object_dict)

参数

名称	说明
workspace 必需	Workspace ComputeInstance 对象的工作区对象与该对象相关联。
object_dict 必需	dict 要转换为 ComputeInstance 对象的 JSON 对象。

类型	说明
ComputeInstance	提供的 JSON 对象的 ComputeInstance 表示形式。

例外

类型	说明
ComputeTargetException

detach

ComputeInstance 对象不支持分离。请改用 delete。

detach()

例外

类型	说明
ComputeTargetException	该作未启动。

get

返回 ComputeInstance 对象。

get()

类型	说明
ComputeInstance	提供的 JSON 对象的 ComputeInstance 表示形式。

例外

类型	说明
ComputeTargetException

get_active_runs

返回此计算的运行生成器。

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

参数

名称	说明
type	str 按提供的类型筛选返回的运行生成器。请参阅 add_type_provider 创建运行类型。默认值: None
tags	str 或 dict 按“tag”或 {“tag”： “value”} 筛选运行默认值: None
properties	str 或 dict 筛选器按“property”或 {“property”： “value”} 运行默认值: None
status	str 运行状态可以是“正在运行”或“已排队”。默认值: None

类型	说明
<xref:builtin.generator>	azureml._restclient.models.RunDto 的生成器

get_docs_url

指向此类文档的 URL。

get_docs_url()

类型	说明
str	网址

get_status

检索 ComputeInstance 的当前详细状态。

get_status()

类型	说明
ComputeInstanceStatus	计算的详细状态对象

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)

参数

名称	说明
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 对象 ID（预览版）。默认值: None
assigned_user_tenant_id	str 已分配用户的 AAD 租户 ID（预览版）。默认值: None

类型	说明
ComputeInstanceProvisioningConfiguration	创建计算对象时要使用的配置对象。

例外

类型	说明
ComputeTargetException

refresh_state

对对象的属性执行就地更新。

此方法根据相应云对象的当前状态更新属性。这主要用于手动轮询计算状态。

refresh_state()

restart

重启 ComputeInstance。

restart(wait_for_completion=False, show_output=False)

参数

名称	说明
wait_for_completion	bool 布尔值等待状态更新。默认为 False。默认值: False
show_output	bool 用于提供更详细输出的布尔值。默认为 False。默认值: False

类型	说明
None	没有

例外

类型	说明
azureml.exceptions.ComputeTargetException:

serialize

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

serialize()

类型	说明
dict	此 ComputeInstance 对象的 JSON 表示形式。

start

启动 ComputeInstance。

start(wait_for_completion=False, show_output=False)

参数

名称	说明
wait_for_completion	bool 是否等待状态更新。默认为 False。默认值: False
show_output	bool 是否提供更详细的输出。默认为 False。默认值: False

类型	说明
None	没有

例外

类型	说明
ComputeTargetException

stop

停止 ComputeInstance。

stop(wait_for_completion=False, show_output=False)

参数

名称	说明
wait_for_completion	bool 是否等待状态更新。默认为 False。默认值: False
show_output	bool 是否提供更详细的输出。默认为 False。默认值: False

类型	说明
None	没有

例外

类型	说明
ComputeTargetException

supported_vmsizes

列出区域中支持的 VM 大小。

static supported_vmsizes(workspace, ___location=None)

参数

名称	说明
workspace 必需	Workspace 工作区。
___location	str 实例的位置。如果未指定，则默认值为工作区位置。默认值: None

类型	说明
list	VM、VCPU 和 RAM 名称所在的区域中支持的 VM 大小列表。

update_sso_settings

更新计算实例的单一登录设置。

update_sso_settings(value)

参数

名称	说明
value 必需	bool sso 设置的值

类型	说明
bool	更新是否成功

wait_for_completion

等待 ComputeInstance 完成预配。

wait_for_completion(show_output=False, is_delete_operation=False)

参数

名称	说明
show_output	bool 是否提供更详细的输出。默认为 False。默认值: False
is_delete_operation	bool 指示作是否用于删除。默认值: False

例外

类型	说明
ComputeTargetException

通过