AmlWindowsCompute 类

这是一个实验性类，用于管理 AmlWindowsCompute 计算目标对象。

Azure 机器学习 Windows 计算 (AmlWindowsCompute) 是托管的计算基础结构，可轻松创建单节点或多节点计算。 该计算是在工作区区域内部创建的，是可与其他用户共享的资源。 AmlWindowsCompute 仅支持作为已装载存储的 Azure 文件存储，并且不支持试验运行的环境定义。

继承

AmlCompute

AmlWindowsCompute

构造函数

AmlWindowsCompute(workspace, name)

参数

workspace

Workspace

必需

包含要检索的 AmlCompute 对象的工作区对象。

name

str

必需

要检索的 AmlWindowsCompute 对象的名称。

方法

create	预配 AmlWindowsCompute 群集。
delete	从关联的工作区删除 AmlCompute 对象。
deserialize	将 JSON 对象转换为 AmlWindowsCompute 对象。 如果提供的工作区不与 Compute 关联，则会失败。
detach	AmlWindowsCompute 对象不支持分离。 请尝试改为使用删除操作。
get	返回计算对象。
get_status	检索 AmlWindowsCompute 集群的当前详细状态。
list_windows_compute_targets	列出工作区内的所有 AmlWindowsCompute 对象。
provisioning_configuration	创建用于预配 AmlWindowsCompute 目标的配置对象。
refresh_state	执行对象属性的就地更新。 基于相应云对象的当前状态。 主要用于手动轮询计算状态。
serialize	将此 AmlWindowsCompute 对象转换为 JSON 序列化字典。
wait_for_completion	等待 AmlWindowsCompute 群集完成预配。 这可以配置为等待最小数量的节点，并在设定的时间段后超时。

create

预配 AmlWindowsCompute 群集。

static create(workspace, name, provisioning_configuration)

参数

workspace

Workspace

必需

要创建 Compute 对象的工作区对象。

name

str

必需

要与 Compute 对象关联的名称。

provisioning_configuration

AmlWindowsComputeProvisioningConfiguration

必需

AmlWindowsComputeProvisioningConfiguration 对象，用于定义如何配置 Windows 群集。

返回

AmlWindowsCompute 的实例。

返回类型

AmlWindowsCompute

例外

ComputeTargetException

delete

从关联的工作区删除 AmlCompute 对象。

delete()

例外

ComputeTargetException

注解

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

deserialize

将 JSON 对象转换为 AmlWindowsCompute 对象。

如果提供的工作区不与 Compute 关联，则会失败。

static deserialize(workspace, object_dict)

参数

workspace

Workspace

必需

AmlWindowsCompute 对象关联的工作区对象。

object_dict

dict

必需

要转换为 AmlWindowsCompute 对象的 JSON 对象。

返回

所提供的 JSON 对象的 AmlWindowsCompute 表示形式。

返回类型

AmlWindowsCompute

例外

ComputeTargetException

detach

AmlWindowsCompute 对象不支持分离。 请尝试改为使用删除操作。

detach()

例外

ComputeTargetException

get

返回计算对象。

get()

例外

ComputeTargetException

get_status

检索 AmlWindowsCompute 集群的当前详细状态。

get_status()

返回

群集的详细状态对象。

返回类型

AmlWindowsComputeStatus

例外

ComputeTargetException

list_windows_compute_targets

列出工作区内的所有 AmlWindowsCompute 对象。

static list_windows_compute_targets(workspace)

参数

workspace

Workspace

必需

包含要列出的对象的工作区对象。

返回

工作区中的计算目标列表。

返回类型

list[AmlWindowsCompute]

例外

ComputeTargetException

provisioning_configuration

创建用于预配 AmlWindowsCompute 目标的配置对象。

static provisioning_configuration(vm_size='', vm_priority='dedicated', vm_image=None, min_nodes=0, max_nodes=None, idle_seconds_before_scaledown=None, admin_username=None, admin_user_password=None, vnet_resourcegroup_name=None, vnet_name=None, subnet_name=None, tags=None, description=None, remote_login_port_public_access='NotSpecified')

参数

vm_size

str

必需

代理 VM 的大小。 此处提供了更多详细信息：https://aka.ms/azureml-vm-details。 请注意，并非所有大小都适用于所有区域，如上一个链接中所述。 默认值为 Standard_NC6。

vm_priority

str

默认值: dedicated

VM 优先级，“专用”或“低优先级”VM。 如果未指定，则默认为“专用”。

vm_image

dict

默认值: None

要用于 Windows 计算目标的虚拟机映像。 示例：{ "id" : "<image_id>/versions/"}.。 请参考创建映像定义。 如果未指定，将默认为 DSVM Windows Server 2016 映像。

min_nodes

int

默认值: 0

要在群集上使用的最小节点数。 如果未指定，将默认为 0。

max_nodes

int

默认值: None

要在群集上使用的最大节点数。 默认值为 4。

idle_seconds_before_scaledown

int

默认值: None

缩减群集之前的节点空闲时间（秒）。 默认值为 120。

admin_username

str

默认值: None

可用于登录到节点的管理员用户帐户名称。

admin_user_password

str

默认值: None

管理员用户帐户的密码。

vnet_resourcegroup_name

str

默认值: None

虚拟网络所在的资源组的名称。

vnet_name

str

默认值: None

虚拟网络的名称。

subnet_name

str

默认值: None

VNet 内子网的名称。

tags

dict[str, str]

默认值: None

要提供给计算对象的键值标记的字典。

description

str

默认值: None

要提供给计算对象的说明。

remote_login_port_public_access

str

默认值: NotSpecified

公共 RDP 端口的状态。 可能的值包括：

• 已禁用 - 指示群集的所有节点上的公共 RDP 端口已关闭。

• 已启用 - 表示公共 RDP 端口在群集的所有节点上都处于打开状态。

• 未指定 - 表示如果定义了 VNet，公共 RDP 端口在群集的所有节点上处于关闭状态，否则在所有节点上处于打开状态。 它只能在创建群集时作为此默认值。 创建后，它将被启用或禁用。

返回

创建计算对象时要使用的配置对象。

返回类型

AmlWindowsComputeProvisioningConfiguration

例外

ComputeTargetException

refresh_state

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

基于相应云对象的当前状态。

主要用于手动轮询计算状态。

refresh_state()

例外

ComputeTargetException

serialize

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

serialize()

返回

此 AmlWindowsComputeStatus 对象的 JSON 表示形式。

返回类型

dict

例外

ComputeTargetException

wait_for_completion

等待 AmlWindowsCompute 群集完成预配。

这可以配置为等待最小数量的节点，并在设定的时间段后超时。

wait_for_completion(show_output=False, min_node_count=None, timeout_in_minutes=20)

参数

show_output

bool

默认值: False

布尔值，用于提供更详细的输出。 默认为 False。

min_node_count

int

默认值: None

在考虑完成预配之前要等待的最小节点数。 这不必等于预配计算的最小节点数，但不应大于此数目。

timeout_in_minutes

int

默认值: 20

在将预配视为失败之前等待的持续时间（以分钟为单位）。 默认为“20”。

例外

ComputeTargetException