Feature Store#

[source]

FeatureStore#

hsfs.feature_store.FeatureStore(
    featurestore_id,
    featurestore_name,
    created,
    project_name,
    project_id,
    offline_featurestore_name,
    online_enabled,
    num_feature_groups=None,
    num_training_datasets=None,
    num_storage_connectors=None,
    num_feature_views=None,
    online_featurestore_name=None,
    online_featurestore_size=None,
    **kwargs
)

Retrieval#

[source]

get_feature_store#

Connection.get_feature_store(name=None, engine=None)

Get a reference to a feature store to perform operations on.

Defaulting to the project name of default feature store. To get a Shared feature stores, the project name of the feature store is required.

Arguments

• name str | None: The name of the feature store, defaults to None.
• engine str | None: Which engine to use, "spark", "python" or "training". Defaults to None, which initializes the engine to Spark if the environment provides Spark, for example on Hopsworks and Databricks, or falls back on Hive in Python if Spark is not available, e.g. on local Python environments or AWS SageMaker. This option allows you to override this behaviour. "training" engine is useful when only feature store metadata is needed, for example training dataset location and label information when Hopsworks training experiment is conducted.

Returns

FeatureStore. A feature store handle object to perform operations on.

Properties#

[source]

id#

Id of the feature store.

[source]

name#

Name of the feature store.

[source]

offline_featurestore_name#

Name of the offline feature store database.

[source]

online_enabled#

Indicator whether online feature store is enabled.

[source]

online_featurestore_name#

Name of the online feature store database.

[source]

project_id#

Id of the project in which the feature store is located.

[source]

project_name#

Name of the project in which the feature store is located.

Methods#

[source]

create_external_feature_group#

FeatureStore.create_external_feature_group(
    name,
    storage_connector,
    query=None,
    data_format=None,
    path="",
    options=None,
    version=None,
    description="",
    primary_key=None,
    embedding_index=None,
    features=None,
    statistics_config=None,
    event_time=None,
    expectation_suite=None,
    online_enabled=False,
    topic_name=None,
    notification_topic_name=None,
    online_config=None,
)

Create a external feature group metadata object.

# connect to the Feature Store
fs = ...

external_fg = fs.create_external_feature_group(
                    name="sales",
                    version=1,
                    description="Physical shop sales features",
                    query=query,
                    storage_connector=connector,
                    primary_key=['ss_store_sk'],
                    event_time='sale_date'
                    )

You can enable online storage for external feature groups, however, the sync from the external storage to Hopsworks online storage needs to be done manually:

external_fg = fs.create_external_feature_group(
            name="sales",
            version=1,
            description="Physical shop sales features",
            query=query,
            storage_connector=connector,
            primary_key=['ss_store_sk'],
            event_time='sale_date',
            online_enabled=True,
            online_config={'online_comments': ['NDB_TABLE=READ_BACKUP=1']}
            )
external_fg.save()

# read from external storage and filter data to sync to online
df = external_fg.read().filter(external_fg.customer_status == "active")

# insert to online storage
external_fg.insert(df)

Arguments

• name str: Name of the external feature group to create.
• storage_connector hsfs.StorageConnector: the storage connector used to establish connectivity with the data source.
• query str | None: A string containing a SQL query valid for the target data source. the query will be used to pull data from the data sources when the feature group is used.
• data_format str | None: If the external feature groups refers to a directory with data, the data format to use when reading it
• path str | None: The location within the scope of the storage connector, from where to read the data for the external feature group
• options Dict[str, str] | None: Additional options to be used by the engine when reading data from the specified storage connector. For example, {"header": True} when reading CSV files with column names in the first row.
• version int | None: Version of the external feature group to retrieve, defaults to None and will create the feature group with incremented version from the last version in the feature store.
• description str | None: A string describing the contents of the external feature group to improve discoverability for Data Scientists, defaults to empty string "".
• primary_key List[str] | None: A list of feature names to be used as primary key for the feature group. This primary key can be a composite key of multiple features and will be used as joining key, if not specified otherwise. Defaults to empty list [], and the feature group won't have any primary key.
• features List[hsfs.feature.Feature] | None: Optionally, define the schema of the external feature group manually as a list of Feature objects. Defaults to empty list [] and will use the schema information of the DataFrame resulting by executing the provided query against the data source.
• statistics_config hsfs.StatisticsConfig | bool | dict | None: A configuration object, or a dictionary with keys "enabled" to generally enable descriptive statistics computation for this external feature group, "correlations" to turn on feature correlation computation, "histograms" to compute feature value frequencies and "exact_uniqueness" to compute uniqueness, distinctness and entropy. The values should be booleans indicating the setting. To fully turn off statistics computation pass statistics_config=False. Defaults to None and will compute only descriptive statistics.

• event_time str | None: Optionally, provide the name of the feature containing the event time for the features in this feature group. If event_time is set the feature group can be used for point-in-time joins. Defaults to None.

  Event time data type restriction

  The supported data types for the event time column are: timestamp, date and bigint.

  • __ online_enabled__: Define whether it should be possible to sync the feature group to the online feature store for low latency access, defaults to False.
  • expectation_suite hsfs.expectation_suite.ExpectationSuite | hsfs.feature_store.great_expectations.core.ExpectationSuite | None: Optionally, attach an expectation suite to the feature group which dataframes should be validated against upon insertion. Defaults to None.
  • topic_name str | None: Optionally, define the name of the topic used for data ingestion. If left undefined it defaults to using project topic.
  • notification_topic_name str | None: Optionally, define the name of the topic used for sending notifications when entries are inserted or updated on the online feature store. If left undefined no notifications are sent.
  • online_config hsfs.online_config.OnlineConfig | Dict[str, Any] | None: Optionally, define configuration which is used to configure online table.

Returns

ExternalFeatureGroup. The external feature group metadata object.

[source]

create_feature_group#

FeatureStore.create_feature_group(
    name,
    version=None,
    description="",
    online_enabled=False,
    time_travel_format="HUDI",
    partition_key=None,
    primary_key=None,
    embedding_index=None,
    hudi_precombine_key=None,
    features=None,
    statistics_config=None,
    event_time=None,
    stream=False,
    expectation_suite=None,
    parents=None,
    topic_name=None,
    notification_topic_name=None,
    transformation_functions=None,
    online_config=None,
    offline_backfill_every_hr=None,
    storage_connector=None,
    path=None,
)

Create a feature group metadata object.

# connect to the Feature Store
fs = ...

# define the on-demand transformation functions
@udf(int)
def plus_one(value):
    return value + 1

@udf(int)
def plus_two(value):
    return value + 2

# construct list of "transformation functions" on features
transformation_functions = [plus_one("feature1"), plus_two("feature2"))]

fg = fs.create_feature_group(
        name='air_quality',
        description='Air Quality characteristics of each day',
        version=1,
        primary_key=['city','date'],
        online_enabled=True,
        event_time='date',
        transformation_functions=transformation_functions,
        online_config={'online_comments': ['NDB_TABLE=READ_BACKUP=1']}
    )

Arguments

• name str: Name of the feature group to create.
• version int | None: Version of the feature group to retrieve, defaults to None and will create the feature group with incremented version from the last version in the feature store.
• description str | None: A string describing the contents of the feature group to improve discoverability for Data Scientists, defaults to empty string "".
• online_enabled bool | None: Define whether the feature group should be made available also in the online feature store for low latency access, defaults to False.
• time_travel_format str | None: Format used for time travel, defaults to "HUDI".
• partition_key List[str] | None: A list of feature names to be used as partition key when writing the feature data to the offline storage, defaults to empty list [].
• primary_key List[str] | None: A list of feature names to be used as primary key for the feature group. This primary key can be a composite key of multiple features and will be used as joining key, if not specified otherwise. Defaults to empty list [], and the feature group won't have any primary key.
• embedding_index hsfs.embedding.EmbeddingIndex | None: EmbeddingIndex. If an embedding index is provided, vector database is used as online feature store. This enables similarity search by using find_neighbors. default to None
• hudi_precombine_key str | None: A feature name to be used as a precombine key for the "HUDI" feature group. Defaults to None. If feature group has time travel format "HUDI" and hudi precombine key was not specified then the first primary key of the feature group will be used as hudi precombine key.
• features List[hsfs.feature.Feature] | None: Optionally, define the schema of the feature group manually as a list of Feature objects. Defaults to empty list [] and will use the schema information of the DataFrame provided in the save method.
• statistics_config hsfs.StatisticsConfig | bool | dict | None: A configuration object, or a dictionary with keys "enabled" to generally enable descriptive statistics computation for this feature group, "correlations" to turn on feature correlation computation, "histograms" to compute feature value frequencies and "exact_uniqueness" to compute uniqueness, distinctness and entropy. The values should be booleans indicating the setting. To fully turn off statistics computation pass statistics_config=False. Defaults to None and will compute only descriptive statistics.

• event_time str | None: Optionally, provide the name of the feature containing the event time for the features in this feature group. If event_time is set the feature group can be used for point-in-time joins. Defaults to None.

  Event time data type restriction

  The supported data types for the event time column are: timestamp, date and bigint.

• __ stream__: Optionally, Define whether the feature group should support real time stream writing capabilities. Stream enabled Feature Groups have unified single API for writing streaming features transparently to both online and offline store.

• expectation_suite hsfs.expectation_suite.ExpectationSuite | hsfs.feature_store.great_expectations.core.ExpectationSuite | None: Optionally, attach an expectation suite to the feature group which dataframes should be validated against upon insertion. Defaults to None.
• parents List[hsfs.feature_group.FeatureGroup] | None: Optionally, Define the parents of this feature group as the origin where the data is coming from.
• topic_name str | None: Optionally, define the name of the topic used for data ingestion. If left undefined it defaults to using project topic.
• notification_topic_name str | None: Optionally, define the name of the topic used for sending notifications when entries are inserted or updated on the online feature store. If left undefined no notifications are sent.
• transformation_functions List[hsfs.transformation_function.TransformationFunction | hsfs.hopsworks_udf.HopsworksUdf] | None: On-Demand Transformation functions attached to the feature group. It can be a list of list of user defined functions defined using the hopsworks @udf decorator. Defaults to None, no transformations.
• online_config hsfs.online_config.OnlineConfig | Dict[str, Any] | None: Optionally, define configuration which is used to configure online table.
• offline_backfill_every_hr int | str | None: Optional. If specified, the materialization job will be scheduled to run periodically. The value can be either an integer representing the number of hours between each run or a string representing a cron expression. Set the value to None to avoid scheduling the materialization job. Defaults to None (i.e no scheduling).
• storage_connector hsfs.StorageConnector | Dict[str, Any]: the storage connector used to establish connectivity with the data source.
• path str | None: The location within the scope of the storage connector, from where to read the data for the external feature group

Returns

FeatureGroup. The feature group metadata object.

[source]

create_feature_view#

FeatureStore.create_feature_view(
    name,
    query,
    version=None,
    description="",
    labels=None,
    inference_helper_columns=None,
    training_helper_columns=None,
    transformation_functions=None,
    logging_enabled=False,
)

Create a feature view metadata object and saved it to hopsworks.

# connect to the Feature Store
fs = ...

# get the feature group instances
fg1 = fs.get_or_create_feature_group(...)
fg2 = fs.get_or_create_feature_group(...)

# construct the query
query = fg1.select_all().join(fg2.select_all())

# define the transformation function as a Hopsworks's UDF
@udf(int)
def plus_one(value):
    return value + 1

# construct list of "transformation functions" on features
transformation_functions = [plus_one("feature1"), plus_one("feature1"))]

feature_view = fs.create_feature_view(
    name='air_quality_fv',
    version=1,
    transformation_functions=transformation_functions,
    query=query
)

# get feature store instance
fs = ...

# define query object
query = ...

# define list of transformation functions
mapping_transformers = ...

# create feature view
feature_view = fs.create_feature_view(
    name='feature_view_name',
    version=1,
    transformation_functions=mapping_transformers,
    query=query
)

Arguments

• name str: Name of the feature view to create.
• query hsfs.constructor.query.Query: Feature store Query.
• version int | None: Version of the feature view to create, defaults to None and will create the feature view with incremented version from the last version in the feature store.
• description str | None: A string describing the contents of the feature view to improve discoverability for Data Scientists, defaults to empty string "".
• labels List[str] | None: A list of feature names constituting the prediction label/feature of the feature view. When replaying a Query during model inference, the label features can be omitted from the feature vector retrieval. Defaults to [], no label.
• inference_helper_columns List[str] | None: A list of feature names that are not used in training the model itself but can be used during batch or online inference for extra information. Inference helper column name(s) must be part of the Query object. If inference helper column name(s) belong to feature group that is part of a Join with prefix defined, then this prefix needs to be prepended to the original column name when defining inference_helper_columns list. When replaying a Query during model inference, the inference helper columns optionally can be omitted during batch (get_batch_data) and will be omitted during online inference (get_feature_vector(s)). To get inference helper column(s) during online inference use get_inference_helper(s) method. Defaults to `[], no helper columns.
• training_helper_columns List[str] | None: A list of feature names that are not the part of the model schema itself but can be used during training as a helper for extra information. Training helper column name(s) must be part of the Query object. If training helper column name(s) belong to feature group that is part of a Join with prefix defined, then this prefix needs to prepended to the original column name when defining training_helper_columns list. When replaying a Query during model inference, the training helper columns will be omitted during both batch and online inference. Training helper columns can be optionally fetched with training data. For more details see documentation for feature view's get training data methods. Defaults to `[], no training helper columns.
• transformation_functions List[hsfs.transformation_function.TransformationFunction | hsfs.hopsworks_udf.HopsworksUdf] | None: Model Dependent Transformation functions attached to the feature view. It can be a list of list of user defined functions defined using the hopsworks @udf decorator. Defaults to None, no transformations.

Returns:

FeatureView: The feature view metadata object.

[source]

create_on_demand_feature_group#

FeatureStore.create_on_demand_feature_group(
    name,
    storage_connector,
    query=None,
    data_format=None,
    path="",
    options=None,
    version=None,
    description="",
    primary_key=None,
    features=None,
    statistics_config=None,
    event_time=None,
    expectation_suite=None,
    topic_name=None,
    notification_topic_name=None,
)

Create a external feature group metadata object.

Arguments

• name str: Name of the external feature group to create.
• storage_connector hsfs.StorageConnector: the storage connector used to establish connectivity with the data source.
• query str | None: A string containing a SQL query valid for the target data source. the query will be used to pull data from the data sources when the feature group is used.
• data_format str | None: If the external feature groups refers to a directory with data, the data format to use when reading it
• path str | None: The location within the scope of the storage connector, from where to read the data for the external feature group
• options Dict[str, str] | None: Additional options to be used by the engine when reading data from the specified storage connector. For example, {"header": True} when reading CSV files with column names in the first row.
• version int | None: Version of the external feature group to retrieve, defaults to None and will create the feature group with incremented version from the last version in the feature store.
• description str | None: A string describing the contents of the external feature group to improve discoverability for Data Scientists, defaults to empty string "".
• primary_key List[str] | None: A list of feature names to be used as primary key for the feature group. This primary key can be a composite key of multiple features and will be used as joining key, if not specified otherwise. Defaults to empty list [], and the feature group won't have any primary key.
• features List[hsfs.feature.Feature] | None: Optionally, define the schema of the external feature group manually as a list of Feature objects. Defaults to empty list [] and will use the schema information of the DataFrame resulting by executing the provided query against the data source.
• statistics_config hsfs.StatisticsConfig | bool | dict | None: A configuration object, or a dictionary with keys "enabled" to generally enable descriptive statistics computation for this external feature group, "correlations" to turn on feature correlation computation, "histograms" to compute feature value frequencies and "exact_uniqueness" to compute uniqueness, distinctness and entropy. The values should be booleans indicating the setting. To fully turn off statistics computation pass statistics_config=False. Defaults to None and will compute only descriptive statistics.
• event_time str | None: Optionally, provide the name of the feature containing the event time for the features in this feature group. If event_time is set the feature group can be used for point-in-time joins. Defaults to None. !!! note "Event time data type restriction" The supported data types for the event time column are: timestamp, date and bigint.
• topic_name str | None: Optionally, define the name of the topic used for data ingestion. If left undefined it defaults to using project topic.
• notification_topic_name str | None: Optionally, define the name of the topic used for sending notifications when entries are inserted or updated on the online feature store. If left undefined no notifications are sent.
• expectation_suite hsfs.expectation_suite.ExpectationSuite | hsfs.feature_store.great_expectations.core.ExpectationSuite | None: Optionally, attach an expectation suite to the feature group which dataframes should be validated against upon insertion. Defaults to None.

Returns

ExternalFeatureGroup. The external feature group metadata object.

[source]

create_training_dataset#

FeatureStore.create_training_dataset(
    name,
    version=None,
    description="",
    data_format="tfrecords",
    coalesce=False,
    storage_connector=None,
    splits=None,
    location="",
    seed=None,
    statistics_config=None,
    label=None,
    transformation_functions=None,
    train_split=None,
)

Create a training dataset metadata object.

Arguments

• name str: Name of the training dataset to create.
• version int | None: Version of the training dataset to retrieve, defaults to None and will create the training dataset with incremented version from the last version in the feature store.
• description str | None: A string describing the contents of the training dataset to improve discoverability for Data Scientists, defaults to empty string "".
• data_format str | None: The data format used to save the training dataset, defaults to "tfrecords"-format.
• coalesce bool | None: If true the training dataset data will be coalesced into a single partition before writing. The resulting training dataset will be a single file per split. Default False.
• storage_connector hsfs.StorageConnector | None: Storage connector defining the sink location for the training dataset, defaults to None, and materializes training dataset on HopsFS.
• splits Dict[str, float] | None: A dictionary defining training dataset splits to be created. Keys in the dictionary define the name of the split as str, values represent percentage of samples in the split as float. Currently, only random splits are supported. Defaults to empty dict{}, creating only a single training dataset without splits.
• location str | None: Path to complement the sink storage connector with, e.g if the storage connector points to an S3 bucket, this path can be used to define a sub-directory inside the bucket to place the training dataset. Defaults to "", saving the training dataset at the root defined by the storage connector.
• seed int | None: Optionally, define a seed to create the random splits with, in order to guarantee reproducability, defaults to None.
• statistics_config hsfs.StatisticsConfig | bool | dict | None: A configuration object, or a dictionary with keys "enabled" to generally enable descriptive statistics computation for this feature group, "correlations" to turn on feature correlation computation and "histograms" to compute feature value frequencies. The values should be booleans indicating the setting. To fully turn off statistics computation pass statistics_config=False. Defaults to None and will compute only descriptive statistics.
• label List[str] | None: A list of feature names constituting the prediction label/feature of the training dataset. When replaying a Query during model inference, the label features can be omitted from the feature vector retrieval. Defaults to [], no label.
• transformation_functions Dict[str, hsfs.transformation_function.TransformationFunction] | None: A dictionary mapping tansformation functions to to the features they should be applied to before writing out the training data and at inference time. Defaults to {}, no transformations.
• train_split str | None: If splits is set, provide the name of the split that is going to be used for training. The statistics of this split will be used for transformation functions if necessary. Defaults to None.

Returns:

TrainingDataset: The training dataset metadata object.

[source]

create_transformation_function#

FeatureStore.create_transformation_function(transformation_function, version=None)

Create a transformation function metadata object.

# define the transformation function as a Hopsworks's UDF
@udf(int)
def plus_one(value):
    return value + 1

# create transformation function
plus_one_meta = fs.create_transformation_function(
        transformation_function=plus_one,
        version=1
    )

# persist transformation function in backend
plus_one_meta.save()

Arguments

• transformation_function hsfs.hopsworks_udf.HopsworksUdf: Hopsworks UDF.

Returns:

TransformationFunction: The TransformationFunction metadata object.

[source]

from_response_json#

FeatureStore.from_response_json(json_dict)

[source]

get_external_feature_group#

FeatureStore.get_external_feature_group(name, version=None)

Get a external feature group entity from the feature store.

Getting a external feature group from the Feature Store means getting its metadata handle so you can subsequently read the data into a Spark or Pandas DataFrame or use the Query-API to perform joins between feature groups.

# connect to the Feature Store
fs = ...

external_fg = fs.get_external_feature_group("external_fg_test")

Arguments

• name str: Name of the external feature group to get.
• version int: Version of the external feature group to retrieve, defaults to None and will return the version=1.

Returns

ExternalFeatureGroup: The external feature group metadata object.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve feature group from the feature store.

[source]

get_external_feature_groups#

FeatureStore.get_external_feature_groups(name)

Get a list of all versions of an external feature group entity from the feature store.

Getting a external feature group from the Feature Store means getting its metadata handle so you can subsequently read the data into a Spark or Pandas DataFrame or use the Query-API to perform joins between feature groups.

# connect to the Feature Store
fs = ...

external_fgs_list = fs.get_external_feature_groups("external_fg_test")

Arguments

• name str: Name of the external feature group to get.

Returns

ExternalFeatureGroup: List of external feature group metadata objects.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve feature group from the feature store.

[source]

get_feature_group#

FeatureStore.get_feature_group(name, version=None)

Get a feature group entity from the feature store.

Getting a feature group from the Feature Store means getting its metadata handle so you can subsequently read the data into a Spark or Pandas DataFrame or use the Query-API to perform joins between feature groups.

# connect to the Feature Store
fs = ...

fg = fs.get_feature_group(
        name="electricity_prices",
        version=1,
    )

Arguments

• name str: Name of the feature group to get.
• version int | None: Version of the feature group to retrieve, defaults to None and will return the version=1.

Returns

FeatureGroup: The feature group metadata object.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve feature group from the feature store.

[source]

get_feature_groups#

FeatureStore.get_feature_groups(name)

Get a list of all versions of a feature group entity from the feature store.

Getting a feature group from the Feature Store means getting its metadata handle so you can subsequently read the data into a Spark or Pandas DataFrame or use the Query-API to perform joins between feature groups.

# connect to the Feature Store
fs = ...

fgs_list = fs.get_feature_groups(
        name="electricity_prices"
    )

Arguments

• name str: Name of the feature group to get.

Returns

FeatureGroup: List of feature group metadata objects.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve feature group from the feature store.

[source]

get_feature_view#

FeatureStore.get_feature_view(name, version=None)

Get a feature view entity from the feature store.

Getting a feature view from the Feature Store means getting its metadata.

# get feature store instance
fs = ...

# get feature view instance
feature_view = fs.get_feature_view(
    name='feature_view_name',
    version=1
)

Arguments

• name str: Name of the feature view to get.
• version int: Version of the feature view to retrieve, defaults to None and will return the version=1.

Returns

FeatureView: The feature view metadata object.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve feature view from the feature store.

[source]

get_feature_views#

FeatureStore.get_feature_views(name)

Get a list of all versions of a feature view entity from the feature store.

Getting a feature view from the Feature Store means getting its metadata.

# get feature store instance
fs = ...

# get a list of all versions of a feature view
feature_view = fs.get_feature_views(
    name='feature_view_name'
)

Arguments

• name str: Name of the feature view to get.

Returns

FeatureView: List of feature view metadata objects.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve feature view from the feature store.

[source]

get_on_demand_feature_group#

FeatureStore.get_on_demand_feature_group(name, version=None)

Get a external feature group entity from the feature store.

Getting a external feature group from the Feature Store means getting its metadata handle so you can subsequently read the data into a Spark or Pandas DataFrame or use the Query-API to perform joins between feature groups.

Arguments

• name str: Name of the external feature group to get.
• version int: Version of the external feature group to retrieve, defaults to None and will return the version=1.

Returns

ExternalFeatureGroup: The external feature group metadata object.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve feature group from the feature store.

[source]

get_on_demand_feature_groups#

FeatureStore.get_on_demand_feature_groups(name)

Get a list of all versions of an external feature group entity from the feature store.

Getting a external feature group from the Feature Store means getting its metadata handle so you can subsequently read the data into a Spark or Pandas DataFrame or use the Query-API to perform joins between feature groups.

Arguments

• name str: Name of the external feature group to get.

Returns

ExternalFeatureGroup: List of external feature group metadata objects.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve feature group from the feature store.

[source]

get_online_storage_connector#

FeatureStore.get_online_storage_connector()

Get the storage connector for the Online Feature Store of the respective project's feature store.

The returned storage connector depends on the project that you are connected to.

# connect to the Feature Store
fs = ...

online_storage_connector = fs.get_online_storage_connector()

Returns

StorageConnector. JDBC storage connector to the Online Feature Store.

[source]

get_or_create_feature_group#

FeatureStore.get_or_create_feature_group(
    name,
    version,
    description="",
    online_enabled=False,
    time_travel_format="HUDI",
    partition_key=None,
    primary_key=None,
    embedding_index=None,
    hudi_precombine_key=None,
    features=None,
    statistics_config=None,
    expectation_suite=None,
    event_time=None,
    stream=False,
    parents=None,
    topic_name=None,
    notification_topic_name=None,
    transformation_functions=None,
    online_config=None,
    offline_backfill_every_hr=None,
    storage_connector=None,
    path=None,
)

Get feature group metadata object or create a new one if it doesn't exist. This method doesn't update existing feature group metadata object.

# connect to the Feature Store
fs = ...

fg = fs.get_or_create_feature_group(
        name="electricity_prices",
        version=1,
        description="Electricity prices from NORD POOL",
        primary_key=["day", "area"],
        online_enabled=True,
        event_time="timestamp",
        transformation_functions=transformation_functions,
        online_config={'online_comments': ['NDB_TABLE=READ_BACKUP=1']}
        )

Arguments

• name str: Name of the feature group to create.
• version int: Version of the feature group to retrieve or create.
• description str | None: A string describing the contents of the feature group to improve discoverability for Data Scientists, defaults to empty string "".
• online_enabled bool | None: Define whether the feature group should be made available also in the online feature store for low latency access, defaults to False.
• time_travel_format str | None: Format used for time travel, defaults to "HUDI".
• partition_key List[str] | None: A list of feature names to be used as partition key when writing the feature data to the offline storage, defaults to empty list [].
• primary_key List[str] | None: A list of feature names to be used as primary key for the feature group. This primary key can be a composite key of multiple features and will be used as joining key, if not specified otherwise. Defaults to empty list [], and the feature group won't have any primary key.
• embedding_index hsfs.embedding.EmbeddingIndex | None: EmbeddingIndex. If an embedding index is provided, the vector database is used as online feature store. This enables similarity search by using find_neighbors. default is None
• hudi_precombine_key str | None: A feature name to be used as a precombine key for the "HUDI" feature group. Defaults to None. If feature group has time travel format "HUDI" and hudi precombine key was not specified then the first primary key of the feature group will be used as hudi precombine key.
• features List[hsfs.feature.Feature] | None: Optionally, define the schema of the feature group manually as a list of Feature objects. Defaults to empty list [] and will use the schema information of the DataFrame provided in the save method.
• statistics_config hsfs.StatisticsConfig | bool | dict | None: A configuration object, or a dictionary with keys "enabled" to generally enable descriptive statistics computation for this feature group, "correlations" to turn on feature correlation computation, "histograms" to compute feature value frequencies and "exact_uniqueness" to compute uniqueness, distinctness and entropy. The values should be booleans indicating the setting. To fully turn off statistics computation pass statistics_config=False. Defaults to None and will compute only descriptive statistics.
• expectation_suite hsfs.expectation_suite.ExpectationSuite | hsfs.feature_store.great_expectations.core.ExpectationSuite | None: Optionally, attach an expectation suite to the feature group which dataframes should be validated against upon insertion. Defaults to None.

• event_time str | None: Optionally, provide the name of the feature containing the event time for the features in this feature group. If event_time is set the feature group can be used for point-in-time joins. Defaults to None.

  Event time data type restriction

  The supported data types for the event time column are: timestamp, date and bigint.

• __ stream__: Optionally, Define whether the feature group should support real time stream writing capabilities. Stream enabled Feature Groups have unified single API for writing streaming features transparently to both online and offline store.

• parents List[hsfs.feature_group.FeatureGroup] | None: Optionally, Define the parents of this feature group as the origin where the data is coming from.
• topic_name str | None: Optionally, define the name of the topic used for data ingestion. If left undefined it defaults to using project topic.
• notification_topic_name str | None: Optionally, define the name of the topic used for sending notifications when entries are inserted or updated on the online feature store. If left undefined no notifications are sent.
• transformation_functions List[hsfs.transformation_function.TransformationFunction | hsfs.hopsworks_udf.HopsworksUdf] | None: On-Demand Transformation functions attached to the feature group. It can be a list of list of user defined functions defined using the hopsworks @udf decorator. Defaults to None, no transformations.
• online_config hsfs.online_config.OnlineConfig | Dict[str, Any] | None: Optionally, define configuration which is used to configure online table.
• offline_backfill_every_hr int | str | None: Optional. If specified, the materialization job will be scheduled to run periodically. The value can be either an integer representing the number of hours between each run or a string representing a cron expression. Set the value to None to avoid scheduling the materialization job. Defaults to None (i.e no automatic scheduling). Applies only on Feature Group creation.
• storage_connector hsfs.StorageConnector | Dict[str, Any]: the storage connector used to establish connectivity with the data source.
• path str | None: The location within the scope of the storage connector, from where to read the data for the external feature group

Returns

FeatureGroup. The feature group metadata object.

[source]

get_or_create_feature_view#

FeatureStore.get_or_create_feature_view(
    name,
    query,
    version,
    description="",
    labels=None,
    inference_helper_columns=None,
    training_helper_columns=None,
    transformation_functions=None,
    logging_enabled=False,
)

Get feature view metadata object or create a new one if it doesn't exist. This method doesn't update existing feature view metadata object.

# connect to the Feature Store
fs = ...

feature_view = fs.get_or_create_feature_view(
    name='bitcoin_feature_view',
    version=1,
    transformation_functions=transformation_functions,
    query=query
)

Arguments

• name str: Name of the feature view to create.
• query hsfs.constructor.query.Query: Feature store Query.
• version int: Version of the feature view to create.
• description str | None: A string describing the contents of the feature view to improve discoverability for Data Scientists, defaults to empty string "".
• labels List[str] | None: A list of feature names constituting the prediction label/feature of the feature view. When replaying a Query during model inference, the label features can be omitted from the feature vector retrieval. Defaults to [], no label.
• inference_helper_columns List[str] | None: A list of feature names that are not used in training the model itself but can be used during batch or online inference for extra information. Inference helper column name(s) must be part of the Query object. If inference helper column name(s) belong to feature group that is part of a Join with prefix defined, then this prefix needs to be prepended to the original column name when defining inference_helper_columns list. When replaying a Query during model inference, the inference helper columns optionally can be omitted during batch (get_batch_data) and will be omitted during online inference (get_feature_vector(s)). To get inference helper column(s) during online inference use get_inference_helper(s) method. Defaults to `[], no helper columns.
• training_helper_columns List[str] | None: A list of feature names that are not the part of the model schema itself but can be used during training as a helper for extra information. Training helper column name(s) must be part of the Query object. If training helper column name(s) belong to feature group that is part of a Join with prefix defined, then this prefix needs to prepended to the original column name when defining training_helper_columns list. When replaying a Query during model inference, the training helper columns will be omitted during both batch and online inference. Training helper columns can be optionally fetched with training data. For more details see documentation for feature view's get training data methods. Defaults to `[], no training helper columns.
• transformation_functions Dict[str, hsfs.transformation_function.TransformationFunction] | None: Model Dependent Transformation functions attached to the feature view. It can be a list of list of user defined functions defined using the hopsworks @udf decorator. Defaults to None, no transformations.
• logging_enabled bool | None: If true, enable feature logging for the feature view.

Returns:

FeatureView: The feature view metadata object.

[source]

get_or_create_spine_group#

FeatureStore.get_or_create_spine_group(
    name,
    version=None,
    description="",
    primary_key=None,
    event_time=None,
    features=None,
    dataframe=None,
)

Create a spine group metadata object.

Instead of using a feature group to save a label/prediction target, you can use a spine together with a dataframe containing the labels. A Spine is essentially a metadata object similar to a feature group, however, the data is not materialized in the feature store. It only containes the needed metadata such as the relevant event time column and primary key columns to perform point-in-time correct joins.

# connect to the Feature Store
fs = ...

spine_df = pd.Dataframe()

spine_group = fs.get_or_create_spine_group(
                    name="sales",
                    version=1,
                    description="Physical shop sales features",
                    primary_key=['ss_store_sk'],
                    event_time='sale_date',
                    dataframe=spine_df
                    )

Note that you can inspect the dataframe in the spine group, or replace the dataframe:

spine_group.dataframe.show()

spine_group.dataframe = new_df

The spine can then be used to construct queries, with only one speciality:

If you want to use the query for a feature view to be used for online serving, you can only select the label or target feature from the spine. For the online lookup, the label is not required, therefore it is important to only select label from the left feature group, so that we don't need to provide a spine for online serving.

These queries can then be used to create feature views. Since the dataframe contained in the spine is not being materialized, every time you use a feature view created with spine to read data you will have to provide a dataframe with the same structure again.

For example, to generate training data:

X_train, X_test, y_train, y_test = feature_view_spine.train_test_split(0.2, spine=training_data_entities)

Or to get batches of fresh data for batch scoring:

feature_view_spine.get_batch_data(spine=scoring_entities_df).show()

Here you have the chance to pass a different set of entities to generate the training dataset.

Sometimes it might be handy to create a feature view with a regular feature group containing the label, but then at serving time to use a spine in order to fetch features for example only for a small set of primary key values. To do this, you can pass the spine group instead of a dataframe. Just make sure it contains the needed primary key, event time and label column.

feature_view.get_batch_data(spine=spine_group)

Arguments

• name str: Name of the spine group to create.
• version int | None: Version of the spine group to retrieve, defaults to None and will create the spine group with incremented version from the last version in the feature store.
• description str | None: A string describing the contents of the spine group to improve discoverability for Data Scientists, defaults to empty string "".
• primary_key List[str] | None: A list of feature names to be used as primary key for the spine group. This primary key can be a composite key of multiple features and will be used as joining key, if not specified otherwise. Defaults to empty list [], and the spine group won't have any primary key.
• event_time str | None: Optionally, provide the name of the feature containing the event time for the features in this spine group. If event_time is set the spine group can be used for point-in-time joins. Defaults to None.

• features List[hsfs.feature.Feature] | None: Optionally, define the schema of the spine group manually as a list of Feature objects. Defaults to empty list [] and will use the schema information of the DataFrame resulting by executing the provided query against the data source.

  Event time data type restriction

  The supported data types for the event time column are: timestamp, date and bigint.

• __ dataframe__: DataFrame, RDD, Ndarray, list. Spine dataframe with primary key, event time and label column to use for point in time join when fetching features.

Returns

SpineGroup. The spine group metadata object.

[source]

get_storage_connector#

FeatureStore.get_storage_connector(name)

Get a previously created storage connector from the feature store.

Storage connectors encapsulate all information needed for the execution engine to read and write to specific storage. This storage can be S3, a JDBC compliant database or the distributed filesystem HOPSFS.

If you want to connect to the online feature store, see the get_online_storage_connector method to get the JDBC connector for the Online Feature Store.

# connect to the Feature Store
fs = ...

sc = fs.get_storage_connector("demo_fs_meb10000_Training_Datasets")

Arguments

• name str: Name of the storage connector to retrieve.

Returns

StorageConnector. Storage connector object.

[source]

get_training_dataset#

FeatureStore.get_training_dataset(name, version=None)

Get a training dataset entity from the feature store.

Getting a training dataset from the Feature Store means getting its metadata handle so you can subsequently read the data into a Spark or Pandas DataFrame.

Arguments

• name str: Name of the training dataset to get.
• version int | None: Version of the training dataset to retrieve, defaults to None and will return the version=1.

Returns

TrainingDataset: The training dataset metadata object.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve training dataset from the feature store.

[source]

get_training_datasets#

FeatureStore.get_training_datasets(name)

Get a list of all versions of a training dataset entity from the feature store.

Getting a training dataset from the Feature Store means getting its metadata handle so you can subsequently read the data into a Spark or Pandas DataFrame.

Arguments

• name str: Name of the training dataset to get.

Returns

TrainingDataset: List of training dataset metadata objects.

Raises

• hsfs.client.exceptions.RestAPIError: If unable to retrieve feature group from the feature store.

[source]

get_transformation_function#

FeatureStore.get_transformation_function(name, version=None)

Get transformation function metadata object.

# get feature store instance
fs = ...

# get transformation function metadata object
plus_one_fn = fs.get_transformation_function(name="plus_one")

# get feature store instance
fs = ...

# get transformation function metadata object
min_max_scaler_fn = fs.get_transformation_function(name="min_max_scaler")

# get feature store instance
fs = ...

# get transformation function metadata object
min_max_scaler = fs.get_transformation_function(name="min_max_scaler", version=2)

You can define in the feature view transformation functions as dict, where key is feature name and value is online transformation function instance. Then the transformation functions are applied when you read training data, get batch data, or get feature vector(s).

# get feature store instance
fs = ...

# define query object
query = ...

# get transformation function metadata object
min_max_scaler = fs.get_transformation_function(name="min_max_scaler", version=1)

# attach transformation functions
feature_view = fs.create_feature_view(
    name='feature_view_name',
    query=query,
    labels=["target_column"],
    transformation_functions=[min_max_scaler("feature1")]
)

Built-in transformation functions are attached in the same way. The only difference is that it will compute the necessary statistics for the specific function in the background. For example min and max values for min_max_scaler; mean and standard deviation for standard_scaler etc.

# get feature store instance
fs = ...

# define query object
query = ...

# retrieve transformation functions
min_max_scaler = fs.get_transformation_function(name="min_max_scaler")
standard_scaler = fs.get_transformation_function(name="standard_scaler")
robust_scaler = fs.get_transformation_function(name="robust_scaler")
label_encoder = fs.get_transformation_function(name="label_encoder")

# attach built-in transformation functions while creating feature view
feature_view = fs.create_feature_view(
    name='transactions_view',
    query=query,
    labels=["fraud_label"],
    transformation_functions = [
        label_encoder("category_column"),
        robust_scaler("weight"),
        min_max_scaler("age"),
        standard_scaler("salary")
    ]
)

Arguments

• name str: name of transformation function.
• version int | None: version of transformation function. Optional, if not provided all functions that match to provided name will be retrieved.

Returns:

TransformationFunction: The TransformationFunction metadata object.

[source]

get_transformation_functions#

FeatureStore.get_transformation_functions()

Get all transformation functions metadata objects.

# get feature store instance
fs = ...

# get all transformation functions
list_transformation_fns = fs.get_transformation_functions()

Returns:

List[TransformationFunction]. List of transformation function instances.

[source]

sql#

FeatureStore.sql(query, dataframe_type="default", online=False, read_options=None)

Execute SQL command on the offline or online feature store database

# connect to the Feature Store
fs = ...

# construct the query and show head rows
query_res_head = fs.sql("SELECT * FROM `fg_1`").head()

Arguments

• query str: The SQL query to execute.
• dataframe_type str | None: str, optional. The type of the returned dataframe. Possible values are "default", "spark","pandas", "polars", "numpy" or "python". Defaults to "default", which maps to Spark dataframe for the Spark Engine and Pandas dataframe for the Python engine.
• online bool | None: Set to true to execute the query against the online feature store. Defaults to False.
• read_options dict | None: Additional options as key/value pairs to pass to the execution engine. For spark engine: Dictionary of read options for Spark. For python engine: If running queries on the online feature store, users can provide an entry {'external': True}, this instructs the library to use the host parameter in the hopsworks.login() to establish the connection to the online feature store. If not set, or set to False, the online feature store storage connector is used which relies on the private ip. Defaults to {}.

Returns

DataFrame: DataFrame depending on the chosen type.