Index Class

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Index asset.

Inheritance

azure.ai.ml.entities._assets._artifacts.artifact.Artifact

Index

Constructor

Index(*, name: str, version: str | None = None, stage: str = 'Development', description: str | None = None, tags: Dict[str, str] | None = None, properties: Dict[str, str] | None = None, path: str | PathLike | None = None, datastore: str | None = None, **kwargs: Any)

Variables

Name	Description
name	str Name of the resource.
version	str Version of the resource.
id	str Fully qualified resource Id: azureml://workspace/{workspaceName}/indexes/{name}/versions/{version} of the index. Required.
stage	str Update stage to 'Archive' for soft delete. Default is Development, which means the asset is under development. Required.
description	Optional[str] Description information of the asset.
tags	Optional[dict[str, str]] Asset's tags.
properties	Optional[dict[str, str]] Asset's properties.
path	Optional[Union[str, PathLike]] The local or remote path to the asset.

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.

path

version

The asset version.

Returns

Type	Description
str	The asset version.