Skip to content

docs: clarify FeatureView ttl behavior #6481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adrynalean wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −7
Open

docs: clarify FeatureView ttl behavior #6481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting-started/concepts/feature-view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Feature views consist of:
* (optional, but recommended) metadata (for example, description, or other free-form metadata via `tags`)
* (optional) `owner`: the email of the primary maintainer
* (optional) `org`: the organizational unit that owns the feature view (e.g. `"ads"`, `"search"`); useful for grouping feature views by team or product area
* (optional) a TTL, which limits how far back Feast will look when generating historical datasets
* (optional) a TTL, which limits how far back Feast will look when generating historical datasets. This does not by itself configure database-level expiration for feature values in online stores.
* (optional) `enable_validation=True`, which enables schema validation during materialization (see [Schema Validation](#schema-validation) below)

Feature views allow Feast to model your existing feature data in a consistent way in both an offline (training) and online (serving) environment. Feature views generally contain features that are properties of a specific object, in which case that object is defined as an entity and included in the feature view.
Expand Down
14 changes: 8 additions & 6 deletions sdk/python/feast/feature_view.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,10 @@ class FeatureView(BaseFeatureView):
Attributes:
name: The unique name of the feature view.
entities: The list of names of entities that this feature view is associated with.
ttl: The amount of time this group of features lives. A ttl of 0 indicates that
this group of features lives forever. Note that large ttl's or a ttl of 0
can result in extremely computationally intensive queries.
ttl: The time window Feast uses when looking back for historical feature
values. A ttl of 0 disables this lookback limit. Note that large ttl
values or a ttl of 0 can result in extremely computationally
intensive queries.
batch_source: Optional batch source of data where this group of features
is stored. If no source is provided, this will be None.
stream_source: The stream source of data where this group of features is stored.
Expand Down Expand Up @@ -193,9 +194,10 @@ def __init__(
and entity columns.
# TODO: clarify that schema is only useful here...
entities (optional): The list of entities with which this group of features is associated.
ttl (optional): The amount of time this group of features lives. A ttl of 0 indicates that
this group of features lives forever. Note that large ttl's or a ttl of 0
can result in extremely computationally intensive queries.
ttl (optional): The time window Feast uses when looking back for historical
feature values. A ttl of 0 disables this lookback limit. Note that
large ttl values or a ttl of 0 can result in extremely computationally
intensive queries.
online (optional): A boolean indicating whether online retrieval is enabled for
this feature view.
offline (optional): A boolean indicating whether write to offline store is enabled for
Expand Down
Loading