FeatureSet Class

Feature Set

Inheritance

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

FeatureSet

Constructor

FeatureSet(*, name: str, version: str, entities: List[str], specification: FeatureSetSpecification | None, stage: str | None = 'Development', description: str | None = None, materialization_settings: MaterializationSettings | None = None, tags: Dict | None = None, **kwargs: Any)

Parameters

Name	Description
name Required	str The name of the Feature Set resource.
version Required	str The version of the Feature Set resource.
entities Required	list[str] Specifies list of entities.
specification Required	FeatureSetSpecification Specifies the feature set spec details.
stage Required	Optional[str] Feature set stage. Allowed values: Development, Production, Archived. Defatuls to Development.
description Required	Optional[str] The description of the Feature Set resource. Defaults to None.
tags Required	Optional[dict[str, str]] Tag dictionary. Tags can be added, removed, and updated. Defaults to None.
materialization_settings Required	Optional[MaterializationSettings] Specifies the materialization settings. Defaults to None.
kwargs Required	dict A dictionary of additional configuration parameters.

Keyword-Only Parameters

Name	Description
name Required
version Required
entities Required
specification Required
stage	default value: Development
description Required
materialization_settings Required
tags Required

Examples

Instantiating a Feature Set object

   from azure.ai.ml.entities import FeatureSet, FeatureSetSpecification

   transaction_fset_config = FeatureSet(
       name="transactions",
       version="1",
       description="7-day and 3-day rolling aggregation of transactions featureset",
       entities=["azureml:account:1"],
       stage="Development",
       specification=FeatureSetSpecification(
           path="../tests/test_configs/feature_set/code_sample/FeatureSetSpec.yaml"
       ),
       tags={"data_type": "nonPII"},
   )

   feature_set_poller = featurestore_client.feature_sets.begin_create_or_update(transaction_fset_config)
   print(feature_set_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.

Keyword-Only Parameters

Name	Description
kwargs	dict Additional arguments to pass to the YAML serializer.

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.