Skip to content

Commit ad008bf

Browse files
fix: Fix some inconsistencies in the docs and comments in the code (#2444)
Signed-off-by: Benjamin Tan <benjamintanweihao@gmail.com>
1 parent ea6a9b2 commit ad008bf

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

sdk/python/feast/feature_store.py

+7-12
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,13 @@ def refresh_registry(self):
159159
Explicitly calling this method allows for direct control of the state of the registry cache. Every time this
160160
method is called the complete registry state will be retrieved from the remote registry store backend
161161
(e.g., GCS, S3), and the cache timer will be reset. If refresh_registry() is run before get_online_features()
162-
is called, then get_online_feature() will use the cached registry instead of retrieving (and caching) the
162+
is called, then get_online_features() will use the cached registry instead of retrieving (and caching) the
163163
registry itself.
164164
165165
Additionally, the TTL for the registry cache can be set to infinity (by setting it to 0), which means that
166166
refresh_registry() will become the only way to update the cached registry. If the TTL is set to a value
167167
greater than 0, then once the cache becomes stale (more time than the TTL has passed), a new cache will be
168-
downloaded synchronously, which may increase latencies if the triggering method is get_online_features()
168+
downloaded synchronously, which may increase latencies if the triggering method is get_online_features().
169169
"""
170170
registry_config = self.config.get_registry_config()
171171
registry = Registry(registry_config, repo_path=self.repo_path)
@@ -488,13 +488,10 @@ def _plan(
488488
489489
The plan method dry-runs registering one or more definitions (e.g., Entity, FeatureView), and produces
490490
a list of all the changes the that would be introduced in the feature repo. The changes computed by the plan
491-
command are for informational purpose, and are not actually applied to the registry.
491+
command are for informational purposes, and are not actually applied to the registry.
492492
493493
Args:
494-
objects: A single object, or a list of objects that are intended to be registered with the Feature Store.
495-
objects_to_delete: A list of objects to be deleted from the registry.
496-
partial: If True, apply will only handle the specified objects; if False, apply will also delete
497-
all the objects in objects_to_delete.
494+
desired_repo_contents: The desired repo state.
498495
499496
Raises:
500497
ValueError: The 'objects' parameter could not be parsed properly.
@@ -1203,8 +1200,7 @@ def get_online_features(
12031200
Exception: No entity with the specified name exists.
12041201
12051202
Examples:
1206-
Materialize all features into the online store over the interval
1207-
from 3 hours ago to 10 minutes ago, and then retrieve these online features.
1203+
Retrieve online features from an online store.
12081204
12091205
>>> from feast import FeatureStore, RepoConfig
12101206
>>> fs = FeatureStore(repo_path="feature_repo")
@@ -1580,7 +1576,7 @@ def _read_from_online_store(
15801576
) -> List[Tuple[List[Timestamp], List["FieldStatus.ValueType"], List[Value]]]:
15811577
""" Read and process data from the OnlineStore for a given FeatureView.
15821578
1583-
This method guarentees that the order of the data in each element of the
1579+
This method guarantees that the order of the data in each element of the
15841580
List returned is the same as the order of `requested_features`.
15851581
15861582
This method assumes that `provider.online_read` returns data for each
@@ -1642,7 +1638,7 @@ def _populate_response_from_feature_data(
16421638
requested_features: Iterable[str],
16431639
table: FeatureView,
16441640
):
1645-
""" Populate the GetOnlineFeaturesReponse with feature data.
1641+
""" Populate the GetOnlineFeaturesResponse with feature data.
16461642
16471643
This method assumes that `_read_from_online_store` returns data for each
16481644
combination of Entities in `entity_rows` in the same order as they
@@ -1707,7 +1703,6 @@ def _augment_response_with_on_demand_transforms(
17071703
full_feature_names: A boolean that provides the option to add the feature view prefixes to the feature names,
17081704
changing them from the format "feature" to "feature_view__feature" (e.g., "daily_transactions" changes to
17091705
"customer_fv__daily_transactions").
1710-
result_rows: List of result rows to be augmented with on demand feature values.
17111706
"""
17121707
requested_odfv_map = {
17131708
odfv.name: odfv for odfv in requested_on_demand_feature_views

0 commit comments

Comments
 (0)