Skip to content

Commit 753bd88

Browse files
authored
chore: Updating quickstart and fixing roadmap + broken links to old alpha docs (#2553)
* chore: Updating quickstart and fixing trailing ) in roadmap + broken link to old alpha docs Signed-off-by: Danny Chiao <danny@tecton.ai> * fix Signed-off-by: Danny Chiao <danny@tecton.ai>
1 parent 1e398d9 commit 753bd88

File tree

11 files changed

+275
-179
lines changed

11 files changed

+275
-179
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The list below contains the functionality that contributors are planning to deve
148148
* [x] [Hive (community plugin)](https://github.com/baineng/feast-hive)
149149
* [x] [Postgres (community plugin)](https://github.com/nossrannug/feast-postgres)
150150
* [x] [Spark (community plugin)](https://docs.feast.dev/reference/data-sources/spark)
151-
* [x] Kafka / Kinesis sources (via [push support into the online store](https://docs.feast.dev/reference/data-sources/push)
151+
* [x] Kafka / Kinesis sources (via [push support into the online store](https://docs.feast.dev/reference/data-sources/push))
152152
* [ ] HTTP source
153153
* **Offline Stores**
154154
* [x] [Snowflake](https://docs.feast.dev/reference/offline-stores/snowflake)

docs/SUMMARY.md

-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@
8585
* [Go-based feature retrieval](reference/feature-servers/go-feature-retrieval.md)
8686
* [\[Alpha\] Data quality monitoring](reference/dqm.md)
8787
* [\[Alpha\] On demand feature view](reference/alpha-on-demand-feature-view.md)
88-
* [\[Alpha\] Stream ingestion](reference/alpha-stream-ingestion.md)
8988
* [\[Alpha\] AWS Lambda feature server](reference/alpha-aws-lambda-feature-server.md)
9089
* [Feast CLI reference](reference/feast-cli-commands.md)
9190
* [Python API reference](http://rtd.feast.dev)

docs/getting-started/third-party-integrations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Don't see your offline store or online store of choice here? Check out our guide
2121
* [x] [Hive (community plugin)](https://github.com/baineng/feast-hive)
2222
* [x] [Postgres (community plugin)](https://github.com/nossrannug/feast-postgres)
2323
* [x] [Spark (community plugin)](https://docs.feast.dev/reference/data-sources/spark)
24-
* [x] Kafka / Kinesis sources (via [push support into the online store](https://docs.feast.dev/reference/data-sources/push)
24+
* [x] Kafka / Kinesis sources (via [push support into the online store](https://docs.feast.dev/reference/data-sources/push))
2525
* [ ] HTTP source
2626

2727
### Offline Stores

docs/roadmap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The list below contains the functionality that contributors are planning to deve
1616
* [x] [Hive (community plugin)](https://github.com/baineng/feast-hive)
1717
* [x] [Postgres (community plugin)](https://github.com/nossrannug/feast-postgres)
1818
* [x] [Spark (community plugin)](https://docs.feast.dev/reference/data-sources/spark)
19-
* [x] Kafka / Kinesis sources (via [push support into the online store](https://docs.feast.dev/reference/data-sources/push)
19+
* [x] Kafka / Kinesis sources (via [push support into the online store](https://docs.feast.dev/reference/data-sources/push))
2020
* [ ] HTTP source
2121
* **Offline Stores**
2222
* [x] [Snowflake](https://docs.feast.dev/reference/offline-stores/snowflake)

examples/quickstart/quickstart.ipynb

+254-157
Large diffs are not rendered by default.

sdk/python/feast/templates/aws/driver_repo.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# construction of feature vectors
99
driver = Entity(
1010
# Name of the entity. Must be unique within a project
11-
name="driver_id",
11+
name="driver",
1212
# The join key of an entity describes the storage level field/column on which
1313
# features can be looked up. The join key is also used to join feature
1414
# tables/views when building feature vectors
@@ -41,7 +41,7 @@
4141
# The list of entities specifies the keys required for joining or looking
4242
# up features from this feature view. The reference provided in this field
4343
# correspond to the name of a defined entity (or entities)
44-
entities=["driver_id"],
44+
entities=["driver"],
4545
# The timedelta is the maximum age that each feature value may have
4646
# relative to its lookup time. For historical features (used in training),
4747
# TTL is relative to each timestamp provided in the entity dataframe.
@@ -60,7 +60,7 @@
6060
# Batch sources are used to find feature values. In the case of this feature
6161
# view we will query a source table on Redshift for driver statistics
6262
# features
63-
batch_source=driver_stats_source,
63+
source=driver_stats_source,
6464
# Tags are user defined key/value pairs that are attached to each
6565
# feature view
6666
tags={"team": "driver_performance"},

sdk/python/feast/templates/gcp/driver_repo.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# construction of feature vectors
99
driver = Entity(
1010
# Name of the entity. Must be unique within a project
11-
name="driver_id",
11+
name="driver",
1212
# The join key of an entity describes the storage level field/column on which
1313
# features can be looked up. The join key is also used to join feature
1414
# tables/views when building feature vectors
@@ -39,7 +39,7 @@
3939
# The list of entities specifies the keys required for joining or looking
4040
# up features from this feature view. The reference provided in this field
4141
# correspond to the name of a defined entity (or entities)
42-
entities=["driver_id"],
42+
entities=["driver"],
4343
# The timedelta is the maximum age that each feature value may have
4444
# relative to its lookup time. For historical features (used in training),
4545
# TTL is relative to each timestamp provided in the entity dataframe.
@@ -58,7 +58,7 @@
5858
# Batch sources are used to find feature values. In the case of this feature
5959
# view we will query a source table on BigQuery for driver statistics
6060
# features
61-
batch_source=driver_stats_source,
61+
source=driver_stats_source,
6262
# Tags are user defined key/value pairs that are attached to each
6363
# feature view
6464
tags={"team": "driver_performance"},

sdk/python/feast/templates/local/example.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,21 @@
1616

1717
# Define an entity for the driver. You can think of entity as a primary key used to
1818
# fetch features.
19-
driver = Entity(name="driver_id", value_type=ValueType.INT64, description="driver id",)
19+
driver = Entity(name="driver", join_key="driver_id", value_type=ValueType.INT64,)
2020

2121
# Our parquet files contain sample data that includes a driver_id column, timestamps and
2222
# three feature column. Here we define a Feature View that will allow us to serve this
2323
# data to our model online.
2424
driver_hourly_stats_view = FeatureView(
2525
name="driver_hourly_stats",
26-
entities=["driver_id"],
26+
entities=["driver"],
2727
ttl=timedelta(days=1),
2828
schema=[
2929
Field(name="conv_rate", dtype=Float32),
3030
Field(name="acc_rate", dtype=Float32),
3131
Field(name="avg_daily_trips", dtype=Int64),
3232
],
3333
online=True,
34-
batch_source=driver_hourly_stats,
34+
source=driver_hourly_stats,
3535
tags={},
3636
)

sdk/python/feast/templates/snowflake/driver_repo.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
# construction of feature vectors
1111
driver = Entity(
1212
# Name of the entity. Must be unique within a project
13-
name="driver_id",
13+
name="driver",
1414
# The join key of an entity describes the storage level field/column on which
1515
# features can be looked up. The join key is also used to join feature
1616
# tables/views when building feature vectors
@@ -43,7 +43,7 @@
4343
# The list of entities specifies the keys required for joining or looking
4444
# up features from this feature view. The reference provided in this field
4545
# correspond to the name of a defined entity (or entities)
46-
entities=["driver_id"],
46+
entities=["driver"],
4747
# The timedelta is the maximum age that each feature value may have
4848
# relative to its lookup time. For historical features (used in training),
4949
# TTL is relative to each timestamp provided in the entity dataframe.

sdk/python/feast/templates/spark/example.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717

1818
# Entity definitions
19-
driver = Entity(name="driver_id", value_type=ValueType.INT64, description="driver id",)
19+
driver = Entity(name="driver", value_type=ValueType.INT64, description="driver id",)
2020
customer = Entity(
21-
name="customer_id", value_type=ValueType.INT64, description="customer id",
21+
name="customer", value_type=ValueType.INT64, description="customer id",
2222
)
2323

2424
# Sources
@@ -40,27 +40,27 @@
4040
# Feature Views
4141
driver_hourly_stats_view = FeatureView(
4242
name="driver_hourly_stats",
43-
entities=["driver_id"],
43+
entities=["driver"],
4444
ttl=timedelta(days=7),
4545
schema=[
4646
Field(name="conv_rate", dtype=Float32),
4747
Field(name="acc_rate", dtype=Float32),
4848
Field(name="avg_daily_trips", dtype=Int64),
4949
],
5050
online=True,
51-
batch_source=driver_hourly_stats,
51+
source=driver_hourly_stats,
5252
tags={},
5353
)
5454
customer_daily_profile_view = FeatureView(
5555
name="customer_daily_profile",
56-
entities=["customer_id"],
56+
entities=["customer"],
5757
ttl=timedelta(days=7),
5858
schema=[
5959
Field(name="current_balance", dtype=Float32),
6060
Field(name="avg_passenger_count", dtype=Float32),
6161
Field(name="lifetime_trip_count", dtype=Int64),
6262
],
6363
online=True,
64-
batch_source=customer_daily_profile,
64+
source=customer_daily_profile,
6565
tags={},
6666
)

sdk/python/tests/utils/online_write_benchmark.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def create_driver_hourly_stats_feature_view(source):
2929
Field(name="acc_rate", dtype=Float32),
3030
Field(name="avg_daily_trips", dtype=Int32),
3131
],
32-
batch_source=source,
32+
source=source,
3333
ttl=timedelta(hours=2),
3434
)
3535
return driver_stats_feature_view

0 commit comments

Comments
 (0)