Skip to content

Commit 43480a4

Browse files
committed
docs: Fix alignment for workshop doc
Signed-off-by: Danny Chiao <danny@tecton.ai>
1 parent 8b68fb9 commit 43480a4

1 file changed

Lines changed: 29 additions & 23 deletions

File tree

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,42 @@
1+
# Learning by example
2+
13
This workshop aims to teach users about Feast.
24

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

57
### Pre-requisites
8+
69
This workshop assumes you have the following installed:
7-
- A local development environment that supports running Jupyter notebooks (e.g. VSCode with Jupyter plugin)
8-
- Python 3.7+
9-
- Java 11 (for Spark, e.g. `brew install java11`)
10-
- pip
11-
- Docker & Docker Compose (e.g. `brew install docker docker-compose`)
12-
- Terraform ([docs](https://learn.hashicorp.com/tutorials/terraform/install-cli#install-terraform))
13-
- AWS CLI
14-
- 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))
10+
11+
* A local development environment that supports running Jupyter notebooks (e.g. VSCode with Jupyter plugin)
12+
* Python 3.7+
13+
* Java 11 (for Spark, e.g. `brew install java11`)
14+
* pip
15+
* Docker & Docker Compose (e.g. `brew install docker docker-compose`)
16+
* Terraform ([docs](https://learn.hashicorp.com/tutorials/terraform/install-cli#install-terraform))
17+
* AWS CLI
18+
* 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))
1519

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

18-
**Caveats**
19-
- 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).
20-
- 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.
22+
#### **Caveats**
23+
24+
* 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).
25+
* 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.
26+
27+
### Modules
2128

22-
## Modules
23-
*See also: [Feast quickstart](https://docs.feast.dev/getting-started/quickstart), [Feast x Great Expectations tutorial](https://docs.feast.dev/tutorials/validating-historical-features)*
29+
_See also:_ [_Feast quickstart_](https://docs.feast.dev/getting-started/quickstart)_,_ [_Feast x Great Expectations tutorial_](https://docs.feast.dev/tutorials/validating-historical-features)
2430

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

27-
| Time (min) | Description | Module&nbsp;&nbsp;&nbsp; |
28-
| :--------: | :---------------------------------------------------------------------- | :------------------------------------------------------------------------- |
29-
| 30-45 | Setting up Feast projects & CI/CD + powering batch predictions | [Module 0](https://github.com/feast-dev/feast-workshop/tree/main/module_0) |
30-
| 15-20 | Streaming ingestion & online feature retrieval with Kafka, Spark, Redis | [Module 1](https://github.com/feast-dev/feast-workshop/tree/main/module_1) |
31-
| 10-15 | Real-time feature engineering with on demand transformations | [Module 2](https://github.com/feast-dev/feast-workshop/tree/main/module_2) |
32-
| TBD | Feature server deployment (embed, as a service, AWS Lambda) | TBD |
33-
| TBD | Versioning features / models in Feast | TBD |
34-
| TBD | Data quality monitoring in Feast | TBD |
35-
| TBD | Batch transformations | TBD |
36-
| TBD | Stream transformations | TBD |
33+
| Time (min) | Description | Module |
34+
| :--------: | ----------------------------------------------------------------------- | --------------------------------------------------------------------------- |
35+
| 30-45 | Setting up Feast projects & CI/CD + powering batch predictions | [Module 0](https://github.com/feast-dev/feast-workshop/tree/main/module\_0) |
36+
| 15-20 | Streaming ingestion & online feature retrieval with Kafka, Spark, Redis | [Module 1](https://github.com/feast-dev/feast-workshop/tree/main/module\_1) |
37+
| 10-15 | Real-time feature engineering with on demand transformations | [Module 2](https://github.com/feast-dev/feast-workshop/tree/main/module\_2) |
38+
| TBD | Feature server deployment (embed, as a service, AWS Lambda) | TBD |
39+
| TBD | Versioning features / models in Feast | TBD |
40+
| TBD | Data quality monitoring in Feast | TBD |
41+
| TBD | Batch transformations | TBD |
42+
| TBD | Stream transformations | TBD |

0 commit comments

Comments
 (0)