Skip to content

docs: Add reference to workshop #2723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adchia merged 3 commits into from
May 20, 2022
Merged

docs: Add reference to workshop #2723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
513313f
fix: Add workshop link to documentation
adchia May 20, 2022
f028279
rename link
adchia May 20, 2022
c659876
rename link
adchia May 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
* [Offline store](getting-started/architecture-and-components/offline-store.md)
* [Online store](getting-started/architecture-and-components/online-store.md)
* [Provider](getting-started/architecture-and-components/provider.md)
* [Learning by example](getting-started/feast-workshop.md)
* [Third party integrations](getting-started/third-party-integrations.md)
* [FAQ](getting-started/faq.md)

Expand Down
36 changes: 36 additions & 0 deletions docs/getting-started/feast-workshop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
This workshop aims to teach users about Feast.

We explain concepts & best practices by example, and also showcase how to address common use cases.

### Pre-requisites
This workshop assumes you have the following installed:
- A local development environment that supports running Jupyter notebooks (e.g. VSCode with Jupyter plugin)
- Python 3.7+
- Java 11 (for Spark, e.g. `brew install java11`)
- pip
- Docker & Docker Compose (e.g. `brew install docker docker-compose`)
- Terraform ([docs](https://learn.hashicorp.com/tutorials/terraform/install-cli#install-terraform))
- AWS CLI
- An AWS account setup with credentials via `aws configure` (e.g see [AWS credentials quickstart](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-creds))

Since we'll be learning how to leverage Feast in CI/CD, you'll also need to fork this workshop repository.

**Caveats**
- M1 Macbook development is untested with this flow. See also [How to run / develop for Feast on M1 Macs](https://github.com/feast-dev/feast/issues/2105).
- Windows development has only been tested with WSL. You will need to follow this [guide](https://docs.docker.com/desktop/windows/wsl/) to have Docker play nicely.

## Modules
*See also: [Feast quickstart](https://docs.feast.dev/getting-started/quickstart), [Feast x Great Expectations tutorial](https://docs.feast.dev/tutorials/validating-historical-features)*

These are meant mostly to be done in order, with examples building on previous concepts.

| Time (min) | Description | Module    |
| :--------: | :---------------------------------------------------------------------- | :------------------------------------------------------------------------- |
| 30-45 | Setting up Feast projects & CI/CD + powering batch predictions | [Module 0](https://github.com/feast-dev/feast-workshop/tree/main/module_0) |
| 15-20 | Streaming ingestion & online feature retrieval with Kafka, Spark, Redis | [Module 1](https://github.com/feast-dev/feast-workshop/tree/main/module_1) |
| 10-15 | Real-time feature engineering with on demand transformations | [Module 2](https://github.com/feast-dev/feast-workshop/tree/main/module_2) |
| TBD | Feature server deployment (embed, as a service, AWS Lambda) | TBD |
| TBD | Versioning features / models in Feast | TBD |
| TBD | Data quality monitoring in Feast | TBD |
| TBD | Batch transformations | TBD |
| TBD | Stream transformations | TBD |