Skip to content

Commit cd95b57

Browse files
authored
Add roadmap to README.md (feast-dev#1843)
* Add templating of roadmap to README.md Signed-off-by: Willem Pienaar <[email protected]> * Add pre-commit hook for building templates Signed-off-by: Willem Pienaar <[email protected]> * Change text in roadmap Signed-off-by: Willem Pienaar <[email protected]> * Add emoji Signed-off-by: Willem Pienaar <[email protected]> * Fix casing Signed-off-by: Willem Pienaar <[email protected]>
1 parent 52085a3 commit cd95b57

File tree

8 files changed

+393
-158
lines changed

8 files changed

+393
-158
lines changed

.pre-commit-config.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,9 @@ repos:
1212
name: Lint
1313
stages: [ push ]
1414
language: system
15-
entry: make lint
15+
entry: make lint
16+
- id: template
17+
name: Build Templates
18+
stages: [ commit ]
19+
language: system
20+
entry: make build-templates

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Setup [`pre-commit`](https://pre-commit.com/) to automatically lint and format t
1414
2. Install `pre-commit` with `pip` &amp; install pre-push hooks
1515
```sh
1616
pip install pre-commit
17-
pre-commit install --hook-type pre-push
17+
pre-commit install --hook-type pre-commit --hook-type pre-push
1818
```
1919
3. On push, the pre-commit hook will run. This runs `make format` and `make lint`.
2020

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,3 +133,6 @@ compile-protos-docs:
133133

134134
build-sphinx: compile-protos-python
135135
cd $(ROOT_DIR)/sdk/python/docs && $(MAKE) build-api-source
136+
137+
build-templates:
138+
python infra/scripts/compile-templates.py

README.md

Lines changed: 95 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!--Do not modify this file. It is auto-generated from a template (infra/templates/README.md.jinja2)-->
2+
13
<p align="center">
24
<a href="https://feast.dev/">
35
<img src="docs/assets/feast_logo.png" width="550">
@@ -19,12 +21,12 @@ Feast is an open source feature store for machine learning. Feast is the fastest
1921

2022
Please see our [documentation](https://docs.feast.dev/) for more information about the project.
2123

22-
## Architecture
24+
## 📐 Architecture
2325
<img src="https://i.imgur.com/IYUMF3Q.png" width="700">
2426

2527
The above architecture is the minimal Feast deployment. Want to run the full Feast on GCP/AWS? Click [here](https://docs.feast.dev/how-to-guides/feast-gcp-aws).
2628

27-
## Getting Started
29+
## 🐣 Getting Started
2830

2931
### 1. Install Feast
3032
```commandline
@@ -61,7 +63,7 @@ entity_df = pd.DataFrame.from_dict({
6163
store = FeatureStore(repo_path=".")
6264

6365
training_df = store.get_historical_features(
64-
entity_df=entity_df,
66+
entity_df=entity_df,
6567
features = [
6668
'driver_hourly_stats:conv_rate',
6769
'driver_hourly_stats:acc_rate',
@@ -123,26 +125,111 @@ pprint(feature_vector)
123125
}
124126
```
125127

126-
## Important resources
128+
## 📦 Functionality and Roadmap
129+
130+
The list below contains Feast functionality that contributors are planning to develop
131+
* Items below may indicate if it is planned for development or whether development is in progress.
132+
* We welcome contribution to all items in the roadmap, especially those that are not currently planned or in development.
133+
* Want to influence our roadmap and prioritization? Submit your feedback to [this form](https://docs.google.com/forms/d/e/1FAIpQLSfa1nRQ0sKz-JEFnMMCi4Jseag_yDssO_3nV9qMfxfrkil-wA/viewform).
134+
* Want to speak to a Feast contributor? We are more than happy to jump on a quick call. Please schedule a time using [Calendly](https://calendly.com/d/x2ry-g5bb/meet-with-feast-team).
135+
136+
- **Data Sources**
137+
- [x] [Redshift source](https://docs.feast.dev/reference/data-sources/redshift)
138+
- [x] [BigQuery source](https://docs.feast.dev/reference/data-sources/bigquery)
139+
- [x] [Parquet file source](https://docs.feast.dev/reference/data-sources/file)
140+
- [ ] Kafka source (Planned for Q4 2021)
141+
- [ ] HTTP source
142+
- [ ] Snowflake source
143+
- [ ] Synapse source
144+
145+
146+
- **Offline Stores**
147+
- [x] [Redshift](https://docs.feast.dev/reference/offline-stores/redshift)
148+
- [x] [BigQuery](https://docs.feast.dev/reference/offline-stores/bigquery)
149+
- [x] [In-memory / Pandas](https://docs.feast.dev/reference/offline-stores/file)
150+
- [x] [Custom offline store support](https://docs.feast.dev/how-to-guides/adding-a-new-offline-store)
151+
- [x] [Hive (community maintained)](https://github.com/baineng/feast-hive)
152+
- [ ] Snowflake
153+
- [ ] Synapse
154+
155+
156+
- **Online Stores**
157+
- [x] [DynamoDB](https://docs.feast.dev/reference/online-stores/dynamodb)
158+
- [x] [Redis](https://docs.feast.dev/reference/online-stores/redis)
159+
- [x] [Datastore](https://docs.feast.dev/reference/online-stores/datastore)
160+
- [x] [SQLite](https://docs.feast.dev/reference/online-stores/sqlite)
161+
- [x] [Custom online store support](https://docs.feast.dev/how-to-guides/adding-support-for-a-new-online-store)
162+
- [ ] Postgres
163+
- [ ] Bigtable
164+
- [ ] Cassandra
165+
166+
167+
- **Streaming**
168+
- [ ] [Custom streaming ingestion job support](https://docs.feast.dev/how-to-guides/creating-a-custom-provider)
169+
- [ ] Streaming ingestion on AWS (Planned for Q4 2021)
170+
- [ ] Streaming ingestion on GCP
171+
172+
173+
- **Feature Engineering**
174+
- [ ] On-demand Transformations (Development in progress. See [RFC](https://docs.google.com/document/d/1lgfIw0Drc65LpaxbUu49RCeJgMew547meSJttnUqz7c/edit#))
175+
- [ ] Batch transformation (SQL)
176+
- [ ] Streaming transformation
177+
178+
179+
- **Deployments**
180+
- [ ] AWS Lambda (Development in progress. See [RFC](https://docs.google.com/document/d/1eZWKWzfBif66LDN32IajpaG-j82LSHCCOzY6R7Ax7MI/edit))
181+
- [ ] Cloud Run
182+
- [ ] Kubernetes
183+
- [ ] KNative
184+
185+
186+
- **Feature Serving**
187+
- [x] Python Client
188+
- [ ] REST Feature Server (Python) (Development in progress. See [RFC](https://docs.google.com/document/d/1iXvFhAsJ5jgAhPOpTdB3j-Wj1S9x3Ev_Wr6ZpnLzER4/edit))
189+
- [ ] gRPC Feature Server (Java) (See [#1497](https://github.com/feast-dev/feast/issues/1497))
190+
- [ ] Java Client
191+
- [ ] Go Client
192+
- [ ] Push API
193+
- [ ] Delete API
194+
- [ ] Feature Logging (for training)
195+
196+
197+
- **Data Quality Management**
198+
- [ ] Data profiling and validation (Great Expectations) (Planned for Q4 2021)
199+
- [ ] Metric production
200+
- [ ] Training-serving skew detection
201+
- [ ] Drift detection
202+
- [ ] Alerting
203+
204+
205+
- **Feature Discovery and Governance**
206+
- [x] Python SDK for browsing feature registry
207+
- [x] CLI for browsing feature registry
208+
- [x] Model-centric feature tracking (feature services)
209+
- [ ] REST API for browsing feature registry
210+
- [ ] Feast Web UI (Planned for Q4 2021)
211+
- [ ] Feature versioning
212+
- [ ] Amundsen integration
213+
214+
## 🎓 Important Resources
127215

128216
Please refer to the official documentation at [Documentation](https://docs.feast.dev/)
129217
* [Quickstart](https://docs.feast.dev/getting-started/quickstart)
130-
* [Roadmap](https://docs.feast.dev/roadmap)
131218
* [Tutorials](https://docs.feast.dev/tutorials/tutorials-overview)
132219
* [Running Feast with GCP/AWS](https://docs.feast.dev/how-to-guides/feast-gcp-aws)
133220
* [Change Log](https://github.com/feast-dev/feast/blob/master/CHANGELOG.md)
134221
* [Slack (#Feast)](https://slack.feast.dev/)
135222

136-
## Contributing
223+
## 👋 Contributing
137224
Feast is a community project and is still under active development. Please have a look at our contributing and development guides if you want to contribute to the project:
138225
- [Contribution Process for Feast](https://docs.feast.dev/project/contributing)
139226
- [Development Guide for Feast](https://docs.feast.dev/project/development-guide)
140227
- [Development Guide for the Main Feast Repository](./CONTRIBUTING.md)
141228

142-
## Contributors ✨
229+
## ✨ Contributors
143230

144231
Thanks goes to these incredible people:
145232

146233
<a href="https://github.com/feast-dev/feast/graphs/contributors">
147234
<img src="https://contrib.rocks/image?repo=feast-dev/feast" />
148-
</a>
235+
</a>

docs/feast-on-kubernetes/getting-started/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Getting started
22

33
{% hint style="danger" %}
4-
Feast on Kubernetes is only supported using Feast 0.9 \(and below\). We are working to add support for Feast on Kubernetes with the latest release of Feast \(0.10+\). Please see our [roadmap](../../roadmap.md) for more details.
4+
Feast on Kubernetes is only supported using Feast 0.9 \(and below\). We are working to add support for Feast on Kubernetes with the latest release of Feast. Please see our [roadmap](../../roadmap.md) for more details.
55
{% endhint %}
66

77
### Install Feast

0 commit comments

Comments
 (0)