Share via

FeatureStoreEntity Class

  • Reference

Feature Store Entity

Inheritance
azure.ai.ml.entities._assets.asset.Asset
FeatureStoreEntity

Constructor

FeatureStoreEntity(*, name: str, version: str, index_columns: List[DataColumn], stage: str | None = 'Development', description: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

The name of the feature store entity resource.
version
Required
str

The version of the feature store entity resource.
index_columns
Required
list[DataColumn]

Specifies index columns of the feature-store entity resource.
stage
Required
Optional[str]

The feature store entity stage. Allowed values: Development, Production, Archived. Defaults to "Development".
description
Required
Optional[str]

The description of the feature store entity resource. Defaults to None.
tags
Required
Optional[dict[str, str]]

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

A dictionary of additional configuration parameters.

Keyword-Only Parameters

Name Description
name
Required
version
Required
index_columns
Required
stage
Default value: Development
description
Required
tags
Required

Examples

Configuring a Feature Store Entity


   from azure.ai.ml.entities import DataColumn, DataColumnType, FeatureStoreEntity

   account_column = DataColumn(name="accountID", type=DataColumnType.STRING)

   account_entity_config = FeatureStoreEntity(
       name="account",
       version="1",
       index_columns=[account_column],
       stage="Development",
       description="This entity represents user account index key accountID.",
       tags={"data_type": "nonPII"},
   )

   # wait for featurestore entity creation
   fs_entity_poller = featurestore_client.feature_store_entities.begin_create_or_update(account_entity_config)
   print(fs_entity_poller.result())

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.