[FSTORE-1269] Extend get_feature_vector in user guide #353
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vatj
requested changes
Mar 19, 2024
| @@ -4,7 +4,7 @@ Once you have trained a model, it is time to deploy it. You can get back all the | |||
| If you want to understand more about the concept of feature vectors, you can refer to [here](../../../concepts/fs/feature_view/online_api.md). | |||
|
|
|||
| ## Retrieval | |||
| You can get back feature vectors from either python or java client by providing the primary key value(s) for the feature view. Note that filters defined in feature view and training data will not be applied when feature vectors are returned. | |||
| You can get back feature vectors from either python or java client by providing the primary key value(s) for the feature view. Note that filters defined in feature view and training data will not be applied when feature vectors are returned. If you need to retrieve a complete value of feature vectors without missing values, the required `entry` are [feature_view.primary_keys](https://docs.hopsworks.ai/feature-store-api/3.7/generated/api/feature_view_api/#primary_keys). Alternative, you can provide the primary key of the feature groups as the key of the entry. It is also possible to provide a subset of the entry, which will be discussed [below](#partial-feature-retrieval). | |||
|
|
|||
| === "Python" | |||
There was a problem hiding this comment.
This looks broken when I look at the preview on Github
There was a problem hiding this comment.
This should work as expected here https://docs.hopsworks.ai/3.7/user_guides/fs/feature_view/feature-vectors/#retrieval
| ### Required entry | ||
| Starting from python client v3.4, you can specify different values for the primary key of the same name which exists in multiple feature groups but is not used as the join key. The table below summarises the value of `primary_keys` in different settings. Considering that you are joining 2 feature groups, namely, `left_fg` and `right_fg`, the feature groups have different primary keys, and features (`feature_*`) in each setting. Also, the 2 feature groups are [joint](https://docs.hopsworks.ai/feature-store-api/3.7/generated/api/query_api/#join) on different *join conditions* and *prefix* as `left_fg.join(right_fg, <join conditions>, prefix=<prefix>)`. | ||
|
|
||
| For java client, and python client before v3.4, the `primary_keys` are the set of primary key of all the feature groups in the query. These key are also compatible to python client starting from v3.4. |
There was a problem hiding this comment.
"These key are also compatible to python client starting from v3.4."
What do you mean?
|
|
||
| For java client, and python client before v3.4, the `primary_keys` are the set of primary key of all the feature groups in the query. These key are also compatible to python client starting from v3.4. | ||
|
|
||
| | Setting | primary key of `left_fg` | primary key of `right_fg` | join conditions | prefix | primary_keys | note | |
There was a problem hiding this comment.
Are all of these cases tested for?
There was a problem hiding this comment.
vatj
approved these changes
Apr 5, 2024
kennethmhc
added a commit
to kennethmhc/logicalclocks.github.io
that referenced
this pull request
Apr 8, 2024
vatj
pushed a commit
that referenced
this pull request
Apr 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.