FeatureStore Class

Feature Store

Inheritance

azure.ai.ml.entities._workspace.workspace.Workspace

FeatureStore

Constructor

FeatureStore(*, name: str, compute_runtime: ComputeRuntime | None = None, offline_store: MaterializationStore | None = None, online_store: MaterializationStore | None = None, materialization_identity: ManagedIdentityConfiguration | None = None, description: str | None = None, tags: Dict[str, str] | None = None, display_name: str | None = None, location: str | None = None, resource_group: str | None = None, hbi_workspace: bool = False, storage_account: str | None = None, container_registry: str | None = None, key_vault: str | None = None, application_insights: str | None = None, customer_managed_key: CustomerManagedKey | None = None, image_build_compute: str | None = None, public_network_access: str | None = None, identity: IdentityConfiguration | None = None, primary_user_assigned_identity: str | None = None, managed_network: ManagedNetwork | None = None, **kwargs: Any)

Parameters

Name	Description
name Required	str The name of the feature store.
compute_runtime Required	Optional[ComputeRuntime] The compute runtime of the feature store. Defaults to None.
offline_store Required	Optional[MaterializationStore] The offline store for feature store. materialization_identity is required when offline_store is passed. Defaults to None.
online_store Required	Optional[MaterializationStore] The online store for feature store. materialization_identity is required when online_store is passed. Defaults to None.
materialization_identity Required	Optional[ManagedIdentityConfiguration] The identity used for materialization. Defaults to None.
description Required	Optional[str] The description of the feature store. Defaults to None.
tags Required	dict Tags of the feature store.
display_name Required	Optional[str] The display name for the feature store. This is non-unique within the resource group. Defaults to None.
location Required	Optional[str] The location to create the feature store in. If not specified, the same location as the resource group will be used. Defaults to None.
resource_group Required	Optional[str] The name of the resource group to create the feature store in. Defaults to None.
hbi_workspace Required	Optional[bool] Boolean for whether the customer data is of high business impact (HBI), containing sensitive business information. Defaults to False. For more information, see https://docs.microsoft.com/azure/machine-learning/concept-data-encryption#encryption-at-rest.
storage_account Required	Optional[str] The resource ID of an existing storage account to use instead of creating a new one. Defaults to None.
container_registry Required	Optional[str] The resource ID of an existing container registry to use instead of creating a new one. Defaults to None.
key_vault Required	Optional[str] The resource ID of an existing key vault to use instead of creating a new one. Defaults to None.
application_insights Required	Optional[str] The resource ID of an existing application insights to use instead of creating a new one. Defaults to None.
customer_managed_key Required	Optional[CustomerManagedKey] The key vault details for encrypting data with customer-managed keys. If not specified, Microsoft-managed keys will be used by default. Defaults to None.
image_build_compute Required	Optional[str] The name of the compute target to use for building environment Docker images with the container registry is behind a VNet. Defaults to None.
public_network_access Required	Optional[str] Whether to allow public endpoint connectivity when a workspace is private link enabled. Defaults to None.
identity Required	Optional[IdentityConfiguration] The workspace's Managed Identity (user assigned, or system assigned). Defaults to None.
primary_user_assigned_identity Required	Optional[str] The workspace's primary user assigned identity. Defaults to None.
managed_network Required	Optional[ManagedNetwork] The workspace's Managed Network configuration. Defaults to None.
kwargs Required	dict A dictionary of additional configuration parameters.

Keyword-Only Parameters

Name	Description
name Required
compute_runtime Required
offline_store Required
online_store Required
materialization_identity Required
description Required
tags Required
display_name Required
location Required
resource_group Required
hbi_workspace Required
storage_account Required
container_registry Required
key_vault Required
application_insights Required
customer_managed_key Required
image_build_compute Required
public_network_access Required
identity Required
primary_user_assigned_identity Required
managed_network Required

Examples

Instantiating a Feature Store object

   from azure.ai.ml.entities import FeatureStore

   featurestore_name = "my-featurestore"
   featurestore_location = "eastus"
   featurestore = FeatureStore(name=featurestore_name, location=featurestore_location)

   # wait for featurestore creation
   fs_poller = ml_client.feature_stores.begin_create(featurestore, update_dependent_resources=True)
   print(fs_poller.result())

Methods

dump	Dump the workspace spec into a file in yaml format.

dump

Dump the workspace spec 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 workspace's spec. 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.

creation_context

The creation context of the resource.

Returns

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

discovery_url

Backend service base URLs for the workspace.

Returns

Type	Description
str	Backend service URLs of the workspace

id

The resource ID.

Returns

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

mlflow_tracking_uri

MLflow tracking uri for the workspace.

Returns

Type	Description
str	Returns mlflow tracking uri of the workspace.