Compute Class

Base class for compute resources.

This class should not be instantiated directly. Instead, use one of its subclasses.

Inheritance

azure.ai.ml.entities._resource.Resource

Compute

azure.ai.ml.entities._mixins.RestTranslatableMixin

Compute

Constructor

Compute(name: str, location: str | None = None, description: str | None = None, resource_id: str | None = None, tags: Dict | None = None, **kwargs: Any)

Parameters

Name	Description
type Required	str The compute type. Accepted values are "amlcompute", "computeinstance", "virtualmachine", "kubernetes", and "synapsespark".
name Required	str Name of the compute resource.
location	Optional[str] The resource location. Defaults to workspace location. default value: None
description	Optional[str] Description of the resource. Defaults to None. default value: None
resource_id	Optional[str] ARM resource id of the underlying compute. Defaults to None. default value: None
tags	Optional[dict[str, str]] A set of tags. Contains resource tags defined as key/value pairs. default value: None

Methods

dump	Dump the compute content into a file in yaml format.

dump

Dump the compute content into a file in yaml format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name	Description
dest Required	Union[<xref:PathLike>, str, IO[AnyStr]] The destination to receive this compute's content. Must be either a path to a local file, or an already-open file stream. If dest is a file path, a new file will be created, and an exception is raised if the file exists. If dest is an open file, the file will be written to directly, and an exception will be raised if the file is not writable.'.

Attributes

base_path

The base path of the resource.

Returns

Type	Description
str	The base path of the resource.

created_on

The compute resource creation timestamp.

Returns

Type	Description
Optional[str]	The compute resource creation timestamp.

creation_context

The creation context of the resource.

Returns

Type	Description
Optional[SystemData]	The creation metadata for the resource.

id

The resource ID.

Returns

Type	Description
Optional[str]	The global ID of the resource, an Azure Resource Manager (ARM) ID.

provisioning_errors

The compute resource provisioning errors.

Returns

Type	Description
Optional[str]	The compute resource provisioning errors.

provisioning_state

The compute resource's provisioning state.

Returns

Type	Description
Optional[str]	The compute resource's provisioning state.

type

The compute type.

Returns

Type	Description
Optional[str]	The compute type.