Share via

Asset Class

  • Reference

Base class for asset.

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

Inheritance
azure.ai.ml.entities._resource.Resource
Asset

Constructor

Asset(name: str | None = None, version: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs: Any)

Parameters

Name Description
name
Optional[str]]

The name of the asset. Defaults to a random GUID.

Default value: None
version
Optional[str]

The version of the asset. Defaults to "1" if no name is provided, otherwise defaults to autoincrement from the last registered version of the asset with that name. For a model name that has never been registered, a default version will be assigned.

Default value: None
description
Optional[str]

The description of the resource. Defaults to None.

Default value: None
tags
Optional[dict[str, str]]

Tag dictionary. Tags can be added, removed, and updated. Defaults to None.

Default value: None
properties
Optional[dict[str, str]]

The asset property dictionary. Defaults to None.

Default value: None

Keyword-Only Parameters

Name Description
kwargs
Optional[dict]

A dictionary of additional configuration parameters.

Methods

dump

Dump the asset content into a file in YAML format.

dump

Dump the asset 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 local path or file stream to write the YAML content to. If dest is a file path, a new file will be created. If dest is an open file, the file will be written to directly.

Exceptions

Type Description
FileExistsError

Raised if dest is a file path and the file already exists.
IOError

Raised if dest is an open file and the file is not writable.

Attributes

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

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.

version

The asset version.

Returns

Type Description
str

The asset version.