# Copyright 2019 The Feast Authors

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

# https://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

import os

import sys

from collections import OrderedDict, defaultdict

from datetime import datetime, timedelta

from pathlib import Path

from typing import Any, Dict, List, Optional, Tuple, Union

import pandas as pd

from colorama import Fore, Style

from tqdm import tqdm

from feast import utils

from feast.entity import Entity

from feast.errors import FeastProviderLoginError, FeatureViewNotFoundException

from feast.feature_view import FeatureView

from feast.infra.provider import Provider, RetrievalJob, get_provider

from feast.online_response import OnlineResponse, _infer_online_entity_rows

from feast.protos.feast.serving.ServingService_pb2 import (

GetOnlineFeaturesRequestV2,

GetOnlineFeaturesResponse,

)

from feast.protos.feast.types.EntityKey_pb2 import EntityKey as EntityKeyProto

from feast.registry import Registry

from feast.repo_config import RepoConfig, load_repo_config

from feast.telemetry import log_exceptions, log_exceptions_and_usage

from feast.version import get_version

class FeatureStore:

"""

A FeatureStore object is used to define, create, and retrieve features.

Args:

repo_path: Path to a `feature_store.yaml` used to configure the feature store

config (RepoConfig): Configuration object used to configure the feature store

"""

config: RepoConfig

repo_path: Path

_registry: Registry

@log_exceptions

def __init__(

self, repo_path: Optional[str] = None, config: Optional[RepoConfig] = None,

):

if repo_path is not None and config is not None:

raise ValueError("You cannot specify both repo_path and config")

if config is not None:

self.repo_path = Path(os.getcwd())

self.config = config

elif repo_path is not None:

self.repo_path = Path(repo_path)

self.config = load_repo_config(Path(repo_path))

else:

raise ValueError("Please specify one of repo_path or config")

registry_config = self.config.get_registry_config()

self._registry = Registry(

registry_path=registry_config.path,

repo_path=self.repo_path,

cache_ttl=timedelta(seconds=registry_config.cache_ttl_seconds),

)

@log_exceptions

def version(self) -> str:

"""Returns the version of the current Feast SDK/CLI"""

return get_version()

@property

def project(self) -> str:

return self.config.project

def _get_provider(self) -> Provider:

# TODO: Bake self.repo_path into self.config so that we dont only have one interface to paths

return get_provider(self.config, self.repo_path)

@log_exceptions_and_usage

def refresh_registry(self):

"""Fetches and caches a copy of the feature registry in memory.

Explicitly calling this method allows for direct control of the state of the registry cache. Every time this

method is called the complete registry state will be retrieved from the remote registry store backend

(e.g., GCS, S3), and the cache timer will be reset. If refresh_registry() is run before get_online_features()

is called, then get_online_feature() will use the cached registry instead of retrieving (and caching) the

registry itself.

Additionally, the TTL for the registry cache can be set to infinity (by setting it to 0), which means that

refresh_registry() will become the only way to update the cached registry. If the TTL is set to a value

greater than 0, then once the cache becomes stale (more time than the TTL has passed), a new cache will be

downloaded synchronously, which may increase latencies if the triggering method is get_online_features()

"""

registry_config = self.config.get_registry_config()

self._registry = Registry(

registry_path=registry_config.path,

repo_path=self.repo_path,

cache_ttl=timedelta(seconds=registry_config.cache_ttl_seconds),

)

self._registry.refresh()

@log_exceptions_and_usage

def list_entities(self, allow_cache: bool = False) -> List[Entity]:

"""

Retrieve a list of entities from the registry

Args:

allow_cache (bool): Whether to allow returning entities from a cached registry

Returns:

List of entities

"""

return self._registry.list_entities(self.project, allow_cache=allow_cache)

@log_exceptions_and_usage

def list_feature_views(self) -> List[FeatureView]:

"""

Retrieve a list of feature views from the registry

Returns:

List of feature views

"""

return self._registry.list_feature_views(self.project)

@log_exceptions_and_usage

def get_entity(self, name: str) -> Entity:

"""

Retrieves an entity.

Args:

name: Name of entity

Returns:

Returns either the specified entity, or raises an exception if

none is found

"""

return self._registry.get_entity(name, self.project)

@log_exceptions_and_usage

def get_feature_view(self, name: str) -> FeatureView:

"""

Retrieves a feature view.

Args:

name: Name of feature view

Returns:

Returns either the specified feature view, or raises an exception if

none is found

"""

return self._registry.get_feature_view(name, self.project)

@log_exceptions_and_usage

def delete_feature_view(self, name: str):

"""

Deletes a feature view or raises an exception if not found.

Args:

name: Name of feature view

"""

return self._registry.delete_feature_view(name, self.project)

@log_exceptions_and_usage

def apply(

self, objects: Union[Entity, FeatureView, List[Union[FeatureView, Entity]]]

):

"""Register objects to metadata store and update related infrastructure.

The apply method registers one or more definitions (e.g., Entity, FeatureView) and registers or updates these

objects in the Feast registry. Once the registry has been updated, the apply method will update related

infrastructure (e.g., create tables in an online store) in order to reflect these new definitions. All

operations are idempotent, meaning they can safely be rerun.

Args:

objects (List[Union[FeatureView, Entity]]): A list of FeatureView or Entity objects that should be

registered

Examples:

Register a single Entity and FeatureView.

>>> from feast.feature_store import FeatureStore

>>> from feast import Entity, FeatureView, Feature, ValueType, FileSource

>>> from datetime import timedelta

>>>

>>> fs = FeatureStore()

>>> customer_entity = Entity(name="customer", value_type=ValueType.INT64, description="customer entity")

>>> customer_feature_view = FeatureView(

>>> name="customer_fv",

>>> entities=["customer"],

>>> features=[Feature(name="age", dtype=ValueType.INT64)],

>>> input=FileSource(path="file.parquet", event_timestamp_column="timestamp"),

>>> ttl=timedelta(days=1)

>>> )

>>> fs.apply([customer_entity, customer_feature_view])

"""

# TODO: Add locking

# TODO: Optimize by only making a single call (read/write)

if isinstance(objects, Entity) or isinstance(objects, FeatureView):

objects = [objects]

assert isinstance(objects, list)

views_to_update = []

entities_to_update = []

for ob in objects:

if isinstance(ob, FeatureView):

self._registry.apply_feature_view(ob, project=self.project)

views_to_update.append(ob)

elif isinstance(ob, Entity):

self._registry.apply_entity(ob, project=self.project)

entities_to_update.append(ob)

else:

raise ValueError(

f"Unknown object type ({type(ob)}) provided as part of apply() call"

)

self._get_provider().update_infra(

project=self.project,

tables_to_delete=[],

tables_to_keep=views_to_update,

entities_to_delete=[],

entities_to_keep=entities_to_update,

partial=True,

)

@log_exceptions_and_usage

def get_historical_features(

self, entity_df: Union[pd.DataFrame, str], feature_refs: List[str],

) -> RetrievalJob:

"""Enrich an entity dataframe with historical feature values for either training or batch scoring.

This method joins historical feature data from one or more feature views to an entity dataframe by using a time

travel join.

Each feature view is joined to the entity dataframe using all entities configured for the respective feature

view. All configured entities must be available in the entity dataframe. Therefore, the entity dataframe must

contain all entities found in all feature views, but the individual feature views can have different entities.

Time travel is based on the configured TTL for each feature view. A shorter TTL will limit the

amount of scanning that will be done in order to find feature data for a specific entity key. Setting a short

TTL may result in null values being returned.

Args:

entity_df (Union[pd.DataFrame, str]): An entity dataframe is a collection of rows containing all entity

columns (e.g., customer_id, driver_id) on which features need to be joined, as well as a event_timestamp

column used to ensure point-in-time correctness. Either a Pandas DataFrame can be provided or a string

SQL query. The query must be of a format supported by the configured offline store (e.g., BigQuery)

feature_refs: A list of features that should be retrieved from the offline store. Feature references are of

the format "feature_view:feature", e.g., "customer_fv:daily_transactions".

Returns:

RetrievalJob which can be used to materialize the results.

Examples:

Retrieve historical features using a BigQuery SQL entity dataframe

>>> from feast.feature_store import FeatureStore

>>>

>>> fs = FeatureStore(config=RepoConfig(provider="gcp"))

>>> retrieval_job = fs.get_historical_features(

>>> entity_df="SELECT event_timestamp, order_id, customer_id from gcp_project.my_ds.customer_orders",

>>> feature_refs=["customer:age", "customer:avg_orders_1d", "customer:avg_orders_7d"]

>>> )

>>> feature_data = job.to_df()

>>> model.fit(feature_data) # insert your modeling framework here.

"""

all_feature_views = self._registry.list_feature_views(project=self.project)

try:

feature_views = _get_requested_feature_views(

feature_refs, all_feature_views

)

except FeatureViewNotFoundException as e:

sys.exit(e)

provider = self._get_provider()

try:

job = provider.get_historical_features(

self.config,

feature_views,

feature_refs,

entity_df,

self._registry,

self.project,

)

except FeastProviderLoginError as e:

sys.exit(e)

return job

@log_exceptions_and_usage

def materialize_incremental(

self, end_date: datetime, feature_views: Optional[List[str]] = None,

) -> None:

"""

Materialize incremental new data from the offline store into the online store.

This method loads incremental new feature data up to the specified end time from either

the specified feature views, or all feature views if none are specified,

into the online store where it is available for online serving. The start time of

the interval materialized is either the most recent end time of a prior materialization or

(now - ttl) if no such prior materialization exists.

Args:

end_date (datetime): End date for time range of data to materialize into the online store

feature_views (List[str]): Optional list of feature view names. If selected, will only run

materialization for the specified feature views.

Examples:

Materialize all features into the online store up to 5 minutes ago.

>>> from datetime import datetime, timedelta

>>> from feast.feature_store import FeatureStore

>>>

>>> fs = FeatureStore(config=RepoConfig(provider="gcp", registry="gs://my-fs/", project="my_fs_proj"))

>>> fs.materialize_incremental(end_date=datetime.utcnow() - timedelta(minutes=5))

"""

feature_views_to_materialize = []

if feature_views is None:

feature_views_to_materialize = self._registry.list_feature_views(

self.project

)

else:

for name in feature_views:

feature_view = self._registry.get_feature_view(name, self.project)

feature_views_to_materialize.append(feature_view)

_print_materialization_log(

None,

end_date,

len(feature_views_to_materialize),

self.config.online_store.type,

)

# TODO paging large loads

for feature_view in feature_views_to_materialize:

start_date = feature_view.most_recent_end_time

if start_date is None:

if feature_view.ttl is None:

raise Exception(

f"No start time found for feature view {feature_view.name}. materialize_incremental() requires"

f" either a ttl to be set or for materialize() to have been run at least once."

)

start_date = datetime.utcnow() - feature_view.ttl

provider = self._get_provider()

print(

f"{Style.BRIGHT + Fore.GREEN}{feature_view.name}{Style.RESET_ALL}"

f" from {Style.BRIGHT + Fore.GREEN}{start_date.replace(microsecond=0).astimezone()}{Style.RESET_ALL}"

f" to {Style.BRIGHT + Fore.GREEN}{end_date.replace(microsecond=0).astimezone()}{Style.RESET_ALL}:"

)

def tqdm_builder(length):

return tqdm(total=length, ncols=100)

provider.materialize_single_feature_view(

feature_view,

start_date,

end_date,

self._registry,

self.project,

tqdm_builder,

)

@log_exceptions_and_usage

def materialize(

self,

start_date: datetime,

end_date: datetime,

feature_views: Optional[List[str]] = None,

) -> None:

"""

Materialize data from the offline store into the online store.

This method loads feature data in the specified interval from either

the specified feature views, or all feature views if none are specified,

into the online store where it is available for online serving.

Args:

start_date (datetime): Start date for time range of data to materialize into the online store

end_date (datetime): End date for time range of data to materialize into the online store

feature_views (List[str]): Optional list of feature view names. If selected, will only run

materialization for the specified feature views.

Examples:

Materialize all features into the online store over the interval

from 3 hours ago to 10 minutes ago.

>>> from datetime import datetime, timedelta

>>> from feast.feature_store import FeatureStore

>>>

>>> fs = FeatureStore(config=RepoConfig(provider="gcp"))

>>> fs.materialize(

>>> start_date=datetime.utcnow() - timedelta(hours=3), end_date=datetime.utcnow() - timedelta(minutes=10)

>>> )

"""

if utils.make_tzaware(start_date) > utils.make_tzaware(end_date):

raise ValueError(

f"The given start_date {start_date} is greater than the given end_date {end_date}."

)

feature_views_to_materialize = []

if feature_views is None:

feature_views_to_materialize = self._registry.list_feature_views(

self.project

)

else:

for name in feature_views:

feature_view = self._registry.get_feature_view(name, self.project)

feature_views_to_materialize.append(feature_view)

_print_materialization_log(

start_date,

end_date,

len(feature_views_to_materialize),

self.config.online_store.type,

)

# TODO paging large loads

for feature_view in feature_views_to_materialize:

provider = self._get_provider()

print(f"{Style.BRIGHT + Fore.GREEN}{feature_view.name}{Style.RESET_ALL}:")

def tqdm_builder(length):

return tqdm(total=length, ncols=100)

provider.materialize_single_feature_view(

feature_view,

start_date,

end_date,

self._registry,

self.project,

tqdm_builder,

)

@log_exceptions_and_usage

def get_online_features(

self, feature_refs: List[str], entity_rows: List[Dict[str, Any]],

) -> OnlineResponse:

"""

Retrieves the latest online feature data.

Note: This method will download the full feature registry the first time it is run. If you are using a

remote registry like GCS or S3 then that may take a few seconds. The registry remains cached up to a TTL

duration (which can be set to infinitey). If the cached registry is stale (more time than the TTL has

passed), then a new registry will be downloaded synchronously by this method. This download may

introduce latency to online feature retrieval. In order to avoid synchronous downloads, please call

refresh_registry() prior to the TTL being reached. Remember it is possible to set the cache TTL to

infinity (cache forever).

Args:

feature_refs: List of feature references that will be returned for each entity.

Each feature reference should have the following format:

"feature_table:feature" where "feature_table" & "feature" refer to

the feature and feature table names respectively.

Only the feature name is required.

entity_rows: A list of dictionaries where each key-value is an entity-name, entity-value pair.

Returns:

OnlineResponse containing the feature data in records.

Examples:

>>> from feast import FeatureStore

>>>

>>> store = FeatureStore(repo_path="...")

>>> feature_refs = ["sales:daily_transactions"]

>>> entity_rows = [{"customer_id": 0},{"customer_id": 1}]

>>>

>>> online_response = store.get_online_features(

>>> feature_refs, entity_rows)

>>> online_response_dict = online_response.to_dict()

>>> print(online_response_dict)

{'sales:daily_transactions': [1.1,1.2], 'sales:customer_id': [0,1]}

"""

provider = self._get_provider()

entities = self.list_entities(allow_cache=True)

entity_name_to_join_key_map = {}

for entity in entities:

entity_name_to_join_key_map[entity.name] = entity.join_key

join_key_rows = []

for row in entity_rows:

join_key_row = {}

for entity_name, entity_value in row.items():

try:

join_key = entity_name_to_join_key_map[entity_name]

except KeyError:

raise Exception(

f"Entity {entity_name} does not exist in project {self.project}"

)

join_key_row[join_key] = entity_value

join_key_rows.append(join_key_row)

entity_row_proto_list = _infer_online_entity_rows(join_key_rows)

union_of_entity_keys = []

result_rows: List[GetOnlineFeaturesResponse.FieldValues] = []

for entity_row_proto in entity_row_proto_list:

union_of_entity_keys.append(_entity_row_to_key(entity_row_proto))

result_rows.append(_entity_row_to_field_values(entity_row_proto))

all_feature_views = self._registry.list_feature_views(

project=self.project, allow_cache=True

)

grouped_refs = _group_refs(feature_refs, all_feature_views)

for table, requested_features in grouped_refs:

entity_keys = _get_table_entity_keys(

table, union_of_entity_keys, entity_name_to_join_key_map

)

read_rows = provider.online_read(

project=self.project, table=table, entity_keys=entity_keys,

)

for row_idx, read_row in enumerate(read_rows):

row_ts, feature_data = read_row

result_row = result_rows[row_idx]

if feature_data is None:

for feature_name in requested_features:

feature_ref = f"{table.name}__{feature_name}"

result_row.statuses[

feature_ref

] = GetOnlineFeaturesResponse.FieldStatus.NOT_FOUND

else:

for feature_name in feature_data:

feature_ref = f"{table.name}__{feature_name}"

if feature_name in requested_features:

result_row.fields[feature_ref].CopyFrom(

feature_data[feature_name]

)

result_row.statuses[

feature_ref

] = GetOnlineFeaturesResponse.FieldStatus.PRESENT

return OnlineResponse(GetOnlineFeaturesResponse(field_values=result_rows))

def _entity_row_to_key(row: GetOnlineFeaturesRequestV2.EntityRow) -> EntityKeyProto:

names, values = zip(*row.fields.items())

return EntityKeyProto(join_keys=names, entity_values=values) # type: ignore

def _entity_row_to_field_values(

row: GetOnlineFeaturesRequestV2.EntityRow,

) -> GetOnlineFeaturesResponse.FieldValues:

result = GetOnlineFeaturesResponse.FieldValues()

for k in row.fields:

result.fields[k].CopyFrom(row.fields[k])

result.statuses[k] = GetOnlineFeaturesResponse.FieldStatus.PRESENT

return result

def _group_refs(

feature_refs: List[str], all_feature_views: List[FeatureView]

) -> List[Tuple[FeatureView, List[str]]]:

""" Get list of feature views and corresponding feature names based on feature references"""

# view name to view proto

view_index = {view.name: view for view in all_feature_views}

# view name to feature names

views_features = defaultdict(list)

for ref in feature_refs:

view_name, feat_name = ref.split(":")

if view_name not in view_index:

raise FeatureViewNotFoundException(view_name)

views_features[view_name].append(feat_name)

result = []

for view_name, feature_names in views_features.items():

result.append((view_index[view_name], feature_names))

return result

def _get_requested_feature_views(

feature_refs: List[str], all_feature_views: List[FeatureView]

) -> List[FeatureView]:

"""Get list of feature views based on feature references"""

# TODO: Get rid of this function. We only need _group_refs

return list(view for view, _ in _group_refs(feature_refs, all_feature_views))

def _get_table_entity_keys(

table: FeatureView, entity_keys: List[EntityKeyProto], join_key_map: Dict[str, str],

) -> List[EntityKeyProto]:

table_join_keys = [join_key_map[entity_name] for entity_name in table.entities]

required_entities = OrderedDict.fromkeys(sorted(table_join_keys))

entity_key_protos = []

for entity_key in entity_keys:

required_entities_to_values = required_entities.copy()

for i in range(len(entity_key.join_keys)):

entity_name = entity_key.join_keys[i]

entity_value = entity_key.entity_values[i]

if entity_name in required_entities_to_values:

if required_entities_to_values[entity_name] is not None:

raise ValueError(

f"Duplicate entity keys detected. Table {table.name} expects {table_join_keys}. The entity "

f"{entity_name} was provided at least twice"

)

required_entities_to_values[entity_name] = entity_value

entity_names = []

entity_values = []

for entity_name, entity_value in required_entities_to_values.items():

if entity_value is None:

raise ValueError(

f"Table {table.name} expects entity field {table_join_keys}. No entity value was found for "

f"{entity_name}"

)

entity_names.append(entity_name)

entity_values.append(entity_value)

entity_key_protos.append(

EntityKeyProto(join_keys=entity_names, entity_values=entity_values)

)

return entity_key_protos

def _print_materialization_log(

start_date, end_date, num_feature_views: int, online_store: str

):

if start_date:

print(

f"Materializing {Style.BRIGHT + Fore.GREEN}{num_feature_views}{Style.RESET_ALL} feature views"

f" from {Style.BRIGHT + Fore.GREEN}{start_date.replace(microsecond=0).astimezone()}{Style.RESET_ALL}"

f" to {Style.BRIGHT + Fore.GREEN}{end_date.replace(microsecond=0).astimezone()}{Style.RESET_ALL}"

f" into the {Style.BRIGHT + Fore.GREEN}{online_store}{Style.RESET_ALL} online store.\n"

)

else:

print(

f"Materializing {Style.BRIGHT + Fore.GREEN}{num_feature_views}{Style.RESET_ALL} feature views"

f" to {Style.BRIGHT + Fore.GREEN}{end_date.replace(microsecond=0).astimezone()}{Style.RESET_ALL}"

f" into the {Style.BRIGHT + Fore.GREEN}{online_store}{Style.RESET_ALL} online store.\n"

)