Skip to content

Commit 9e50e18

Browse files
jyejarejyejare
authored
feat: Serialization version 2 and below removed (#5435)
1 parent 8a37bf5 commit 9e50e18

File tree

90 files changed

+217
-228
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+217
-228
lines changed

‎docs/getting-started/quickstart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ provider: local
113113
online_store:
114114
type: sqlite
115115
path: data/online_store.db
116-
entity_key_serialization_version: 2
116+
entity_key_serialization_version: 3
117117
```
118118
{% endtab %}
119119

‎docs/how-to-guides/entity-reserialization-of-from-v2-to-v3.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Entity Key Re-Serialization from Version 2 to 3
1+
# Entity Key Serialization from Version 2 to Version 3
22

3-
Entity Key Serialization version 2 will soon be deprecated, hence we need to shift the serialization and deserilization to version 3.
3+
Entity Key Serialization version 2 is now deprecated. All new and existing Feast deployments should shift to using serialization version 3.
44

5-
But here comes the challegnge where existing FeatuteViews on stores has written features with version 2. A version 2 serialized entity key cant be retrived using version 3 deserilization algorithm.
5+
However, a challenge arises when existing FeatureViews in online or offline stores have written features with version 2. A version 2 serialized entity key cannot be retrieved using the version 3 deserialization algorithm.
66

77
## Reserialize the Feature Views entity Keys to version 3
88

99
The solution is to reserialize the entity keys from version 2 to version 3.
1010

1111
Follow the following procedures to reserialize the entity key to version 3 in feature View in an offline / online store.
1212

13-
In hosrt, you need to iterate through all the feature views in your Feast repository, retrieve their serialized entity keys (if stored in version 2), reserialize them to version 3, and then update the online/offline store or wherever the serialized keys are stored.
13+
In short, you need to iterate through all the feature views in your Feast repository, retrieve their serialized entity keys (if stored in version 2), reserialize them to version 3, and then update the online/offline store or wherever the serialized keys are stored.
1414

1515
### 1. Initialize the Feature Store
1616

‎docs/how-to-guides/running-feast-in-production.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ def materialize(data_interval_start=None, data_interval_end=None):
8888
provider="aws",
8989
offline_store="file",
9090
online_store=DynamoDBOnlineStoreConfig(region="us-west-2"),
91-
entity_key_serialization_version=2
91+
entity_key_serialization_version=3
9292
)
9393
store = FeatureStore(config=repo_config)
9494
# Option 1: materialize just one feature view

‎docs/how-to-guides/starting-feast-servers-tls-mode.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ online_store:
8383
path: http://localhost:6566
8484
type: remote
8585
cert: /path/to/cert.pem
86-
entity_key_serialization_version: 2
86+
entity_key_serialization_version: 3
8787
auth:
8888
type: no_auth
8989
```
@@ -121,7 +121,7 @@ online_store:
121121
path: http://localhost:6566
122122
type: remote
123123
cert: /path/to/cert.pem
124-
entity_key_serialization_version: 2
124+
entity_key_serialization_version: 3
125125
auth:
126126
type: no_auth
127127
```
@@ -161,7 +161,7 @@ online_store:
161161
path: http://localhost:6566
162162
type: remote
163163
cert: /path/to/cert.pem
164-
entity_key_serialization_version: 2
164+
entity_key_serialization_version: 3
165165
offline_store:
166166
type: remote
167167
host: localhost

‎docs/reference/batch-materialization/spark.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ repo_config = RepoConfig(
4747
"partitions": 10
4848
},
4949
online_store=DynamoDBOnlineStoreConfig(region="us-west-1"),
50-
entity_key_serialization_version=2
50+
entity_key_serialization_version=3
5151
)
5252

5353
store = FeatureStore(config=repo_config)

‎docs/reference/feast-cli-commands.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ online_store:
7979
path: data/online_store.db
8080
offline_store:
8181
type: dask
82-
entity_key_serialization_version: 2
82+
entity_key_serialization_version: 3
8383
auth:
8484
type: no_auth
8585
```

‎docs/reference/online-stores/couchbase.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ online_store:
4444
password: password # Couchbase password from access credentials
4545
bucket_name: feast # Couchbase bucket name, defaults to feast
4646
kv_port: 11210 # Couchbase key-value port, defaults to 11210. Required if custom ports are used.
47-
entity_key_serialization_version: 2
47+
entity_key_serialization_version: 3
4848
```
4949
{% endcode %}
5050

‎docs/reference/online-stores/remote.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ online_store:
1717
path: http://localhost:6566
1818
type: remote
1919
cert: /path/to/cert.pem
20-
entity_key_serialization_version: 2
20+
entity_key_serialization_version: 3
2121
auth:
2222
type: no_auth
2323
```

‎examples/credit-risk-end-to-end/02_Deploying_the_Feature_Store.ipynb‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
},
6363
{
6464
"cell_type": "code",
65-
"execution_count": 1,
65+
"execution_count": 2,
6666
"id": "8bd21689-4a8e-4b0c-937d-0911df9db1d3",
6767
"metadata": {},
6868
"outputs": [],
@@ -102,15 +102,15 @@
102102
},
103103
{
104104
"cell_type": "code",
105-
"execution_count": 2,
105+
"execution_count": 6,
106106
"id": "b3757221-2037-49eb-867f-b9529fec06e2",
107107
"metadata": {},
108108
"outputs": [
109109
{
110110
"name": "stdout",
111111
"output_type": "stream",
112112
"text": [
113-
"Writing Feature_Store/feature_store.yaml\n"
113+
"Overwriting Feature_Store/feature_store.yaml\n"
114114
]
115115
}
116116
],
@@ -125,7 +125,7 @@
125125
"online_store:\n",
126126
" type: sqlite\n",
127127
" path: data/online_store.db\n",
128-
"entity_key_serialization_version: 2"
128+
"entity_key_serialization_version: 3"
129129
]
130130
},
131131
{
@@ -383,10 +383,18 @@
383383
"id": "c764a60a-b911-41a8-ba8f-7ef0a0bc7257",
384384
"metadata": {},
385385
"outputs": [
386+
{
387+
"name": "stderr",
388+
"output_type": "stream",
389+
"text": [
390+
"/Users/jyejare/gitrepos/feast/.venv/lib/python3.11/site-packages/pydantic/_internal/_fields.py:192: UserWarning: Field name \"vector_enabled\" in \"SqliteOnlineStoreConfig\" shadows an attribute in parent \"VectorStoreConfig\"\n",
391+
" warnings.warn(\n"
392+
]
393+
},
386394
{
387395
"data": {
388396
"text/plain": [
389-
"RepoConfig(project='loan_applications', provider='local', registry_config='data/registry.db', online_config={'type': 'sqlite', 'path': 'data/online_store.db'}, offline_config={'type': 'dask'}, batch_engine_config='local', feature_server=None, flags=None, repo_path=PosixPath('Feature_Store'), entity_key_serialization_version=2, coerce_tz_aware=True)"
397+
"RepoConfig(project='loan_applications', provider='local', registry_config='data/registry.db', online_config={'type': 'sqlite', 'path': 'data/online_store.db'}, auth={'type': 'no_auth'}, offline_config={'type': 'dask'}, batch_engine_config='local', feature_server=None, flags=None, repo_path=PosixPath('Feature_Store'), entity_key_serialization_version=3, coerce_tz_aware=True)"
390398
]
391399
},
392400
"execution_count": 7,
@@ -779,7 +787,7 @@
779787
],
780788
"metadata": {
781789
"kernelspec": {
782-
"display_name": "Python 3 (ipykernel)",
790+
"display_name": ".venv",
783791
"language": "python",
784792
"name": "python3"
785793
},
@@ -793,7 +801,7 @@
793801
"name": "python",
794802
"nbconvert_exporter": "python",
795803
"pygments_lexer": "ipython3",
796-
"version": "3.11.9"
804+
"version": "3.11.13"
797805
}
798806
},
799807
"nbformat": 4,

‎examples/credit-risk-end-to-end/03_Credit_Risk_Model_Training.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@
256256
" \"host\": \"localhost\",\n",
257257
" \"port\": 8815\n",
258258
" },\n",
259-
" entity_key_serialization_version=2\n",
259+
" entity_key_serialization_version=3\n",
260260
"))"
261261
]
262262
},

0 commit comments

Comments
 (0)