feat: Add demo notebooks for users#6387
Open
ntkathole wants to merge 1 commit intofeast-dev:masterfrom
Open
Conversation
Signed-off-by: ntkathole <nikhilkathole2683@gmail.com>
This file contains hidden or 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
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.
What this PR does / why we need it:
Users onboarding to a Feast have no standardized way to explore their project or learn how to retrieve features. They must manually read documentation and write boilerplate code to understand what entities, feature views, and services exist and how to use them for training or serving.
This PR adds a new
copy_demo_notebooks()function to the Feast Python SDK (and a corresponding feast demo-notebooks CLI command) that generates tailored Jupyter notebooks for any Feast project. The notebooks auto-adapt to the project's feature_store.yaml configuration and provide ready-to-run examples for data scientists.A single command generates a set of project-specific demo notebooks:
Or via CLI:
# feast demo-notebooksGenerated notebooks:
01_feature_store_overview.ipynb - Explore registered entities, feature views, services, and data sources
02_historical_features_training.ipynb - Build training datasets using point-in-time correct historical retrieval
03_online_features_serving.ipynb - Materialize features and serve them at low latency for inference