Skip to content

Commit

Permalink
Fix some inconsistencies in the docs
Browse files Browse the repository at this point in the history
Signed-off-by: Benjamin Tan <benjamintanweihao@gmail.com>
  • Loading branch information
benjamintanweihao authored and Benjamin Tan committed Mar 24, 2022
1 parent ea6a9b2 commit 6e90987
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions sdk/python/feast/feature_store.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,13 +159,13 @@ def refresh_registry(self):
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
is called, then get_online_features() 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()
downloaded synchronously, which may increase latencies if the triggering method is get_online_features().
"""
registry_config = self.config.get_registry_config()
registry = Registry(registry_config, repo_path=self.repo_path)
Expand Down Expand Up @@ -488,13 +488,10 @@ def _plan(
The plan method dry-runs registering one or more definitions (e.g., Entity, FeatureView), and produces
a list of all the changes the that would be introduced in the feature repo. The changes computed by the plan
command are for informational purpose, and are not actually applied to the registry.
command are for informational purposes, and are not actually applied to the registry.
Args:
objects: A single object, or a list of objects that are intended to be registered with the Feature Store.
objects_to_delete: A list of objects to be deleted from the registry.
partial: If True, apply will only handle the specified objects; if False, apply will also delete
all the objects in objects_to_delete.
desired_repo_contents: The desired repo state.
Raises:
ValueError: The 'objects' parameter could not be parsed properly.
Expand Down Expand Up @@ -1203,8 +1200,7 @@ def get_online_features(
Exception: No entity with the specified name exists.
Examples:
Materialize all features into the online store over the interval
from 3 hours ago to 10 minutes ago, and then retrieve these online features.
Retrieve online features from an online store.
>>> from feast import FeatureStore, RepoConfig
>>> fs = FeatureStore(repo_path="feature_repo")
Expand Down Expand Up @@ -1580,7 +1576,7 @@ def _read_from_online_store(
) -> List[Tuple[List[Timestamp], List["FieldStatus.ValueType"], List[Value]]]:
""" Read and process data from the OnlineStore for a given FeatureView.
This method guarentees that the order of the data in each element of the
This method guarantees that the order of the data in each element of the
List returned is the same as the order of `requested_features`.
This method assumes that `provider.online_read` returns data for each
Expand Down Expand Up @@ -1642,7 +1638,7 @@ def _populate_response_from_feature_data(
requested_features: Iterable[str],
table: FeatureView,
):
""" Populate the GetOnlineFeaturesReponse with feature data.
""" Populate the GetOnlineFeaturesResponse with feature data.
This method assumes that `_read_from_online_store` returns data for each
combination of Entities in `entity_rows` in the same order as they
Expand Down Expand Up @@ -1707,7 +1703,6 @@ def _augment_response_with_on_demand_transforms(
full_feature_names: A boolean that provides the option to add the feature view prefixes to the feature names,
changing them from the format "feature" to "feature_view__feature" (e.g., "daily_transactions" changes to
"customer_fv__daily_transactions").
result_rows: List of result rows to be augmented with on demand feature values.
"""
requested_odfv_map = {
odfv.name: odfv for odfv in requested_on_demand_feature_views
Expand Down

0 comments on commit 6e90987

Please sign in to comment.