@@ -111,10 +111,12 @@ class FeatureStore:
111
111
"""
112
112
A FeatureStore object is used to define, create, and retrieve features.
113
113
114
- Args:
115
- repo_path (optional): Path to a `feature_store.yaml` used to configure the
116
- feature store.
117
- config (optional): Configuration object used to configure the feature store.
114
+ Attributes:
115
+ config: The config for the feature store.
116
+ repo_path: The path to the feature repo.
117
+ _registry: The registry for the feature store.
118
+ _provider: The provider for the feature store.
119
+ _go_server: The (optional) Go feature server for the feature store.
118
120
"""
119
121
120
122
config : RepoConfig
@@ -133,11 +135,17 @@ def __init__(
133
135
"""
134
136
Creates a FeatureStore object.
135
137
138
+ Args:
139
+ repo_path (optional): Path to the feature repo. Defaults to the current working directory.
140
+ config (optional): Configuration object used to configure the feature store.
141
+ fs_yaml_file (optional): Path to the `feature_store.yaml` file used to configure the feature store.
142
+ At most one of 'fs_yaml_file' and 'config' can be set.
143
+
136
144
Raises:
137
145
ValueError: If both or neither of repo_path and config are specified.
138
146
"""
139
147
if fs_yaml_file is not None and config is not None :
140
- raise ValueError ("You cannot specify both fs_yaml_dir and config." )
148
+ raise ValueError ("You cannot specify both fs_yaml_file and config." )
141
149
142
150
if repo_path :
143
151
self .repo_path = Path (repo_path )
@@ -150,12 +158,10 @@ def __init__(
150
158
self .config = config
151
159
elif fs_yaml_file is not None :
152
160
self .config = load_repo_config (self .repo_path , fs_yaml_file )
153
- elif repo_path :
161
+ else :
154
162
self .config = load_repo_config (
155
- self .repo_path , Path (repo_path ) / "feature_store.yaml"
163
+ self .repo_path , Path (self . repo_path ) / "feature_store.yaml"
156
164
)
157
- else :
158
- raise ValueError ("Please specify one of fs_yaml_dir or config." )
159
165
160
166
registry_config = self .config .get_registry_config ()
161
167
if registry_config .registry_type == "sql" :
@@ -1447,7 +1453,12 @@ def write_to_online_store(
1447
1453
allow_registry_cache : bool = True ,
1448
1454
):
1449
1455
"""
1450
- ingests data directly into the Online store
1456
+ Persists a dataframe to the online store.
1457
+
1458
+ Args:
1459
+ feature_view_name: The feature view to which the dataframe corresponds.
1460
+ df: The dataframe to be persisted.
1461
+ allow_registry_cache (optional): Whether to allow retrieving feature views from a cached registry.
1451
1462
"""
1452
1463
# TODO: restrict this to work with online StreamFeatureViews and validate the FeatureView type
1453
1464
try :
0 commit comments