Skip to content

Commit 2689d3f

Browse files
davitbzhdavitbzh
andauthored
primary_keys -> primary_key (logicalclocks#394)
Co-authored-by: davitbzh <davit.bzhalava@gmail..com>
1 parent 463aa13 commit 2689d3f

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/user_guides/fs/feature_view/batch-data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ It is very common that ML models are deployed in a "batch" setting where ML pipe
1919
## Retrieve batch data with primary keys and event time
2020
For certain use cases, e.g. time series models, the input data needs to be sorted according to the primary key(s) and event time combination. Or one might want to merge predictions back with the original input data for postmortem analysis.
2121
Primary key(s) and event time are not usually included in the feature view query as they are not features used for training.
22-
To retrieve the primary key(s) and/or event time when retrieving batch data for inference, you need to set the parameters `primary_keys=True` and/or `event_time=True`.
22+
To retrieve the primary key(s) and/or event time when retrieving batch data for inference, you need to set the parameters `primary_key=True` and/or `event_time=True`.
2323

2424
=== "Python"
2525
```python
2626
# get batch data
2727
df = feature_view.get_batch_data(
2828
start_time = "20220620",
2929
end_time = "20220627",
30-
primary_keys=True,
30+
primary_key=True,
3131
event_time=True
3232
) # return a dataframe with primary keys and event time
3333
```

docs/user_guides/fs/feature_view/training-data.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,21 +97,21 @@ X_train, X_val, X_test, y_train, y_val, y_test = feature_view.get_train_validati
9797
## Read training data with primary key(s) and event time
9898
For certain use cases, e.g. time series models, the input data needs to be sorted according to the primary key(s) and event time combination.
9999
Primary key(s) and event time are not usually included in the feature view query as they are not features used for training.
100-
To retrieve the primary key(s) and/or event time when retrieving training data, you need to set the parameters `primary_keys=True` and/or `event_time=True`.
100+
To retrieve the primary key(s) and/or event time when retrieving training data, you need to set the parameters `primary_key=True` and/or `event_time=True`.
101101

102102

103103
```python
104104
# get a training dataset
105105
X_train, X_test, y_train, y_test = feature_view.get_train_test_split(training_dataset_version=1,
106-
primary_keys=True,
106+
primary_key=True,
107107
event_time=True)
108108
```
109109

110110
!!! note
111111
All primary and event time columns of all the feature groups included in the feature view will be returned. If they have the same names across feature groups and the join prefix was not provided then reading operation will fail with ambiguous column exception.
112112
Make sure to define the join prefix if primary key and event time columns have the same names across feature groups.
113113

114-
To use primary key(s) and event time column with materialized training datasets it needs to be created with `primary_keys=True` and/or `with_event_time=True`.
114+
To use primary key(s) and event time column with materialized training datasets it needs to be created with `primary_key=True` and/or `with_event_time=True`.
115115

116116
## Deletion
117117
To clean up unused training data, you can delete all training data or for a particular version. Note that all metadata of training data and materialised files stored in HopsFS will be deleted and cannot be recreated anymore.

0 commit comments

Comments
 (0)