Skip to content

Commit 3e42fb3

Browse files
felixwang9817gitbook-bot
authored andcommitted
GitBook: [#322] Redis
1 parent 47998b9 commit 3e42fb3

File tree

3 files changed

+20
-15
lines changed

3 files changed

+20
-15
lines changed

docs/getting-started/quickstart.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ In this tutorial we will
99

1010
You can run this tutorial in Google Colab or run it on your localhost, following the guided steps below.
1111

12-
![](../.gitbook/assets/colab_logo\_32px.png)[**Run in Google Colab**](https://colab.research.google.com/github/feast-dev/feast/blob/master/examples/quickstart/quickstart.ipynb)****
12+
![](../.gitbook/assets/colab\_logo\_32px.png)[**Run in Google Colab**](https://colab.research.google.com/github/feast-dev/feast/blob/master/examples/quickstart/quickstart.ipynb)****
1313

1414
## Overview
1515

16-
In this tutorial, we use feature stores to generate training data and power online model inference for a ride-sharing driver satisfaction prediction model. Feast solves several common issues in this flow:
16+
In this tutorial, we use feature stores to generate training data and power online model inference for a ride-sharing driver satisfaction prediction model. Feast solves several common issues in this flow: 
1717

1818
1. **Training-serving skew and complex data joins:** Feature values often exist across multiple tables. Joining these datasets can be complicated, slow, and error-prone.
1919
* Feast joins these tables with battle-tested logic that ensures _point-in-time_ correctness so future feature values do not leak to models.
20-
* _\*Upcoming_: Feast alerts users to offline / online skew with data quality monitoring.
21-
2. **Online feature availability:** At inference time, models often need access to features that aren't readily available and need to be precomputed from other datasources.
20+
* _\*Upcoming_: Feast alerts users to offline / online skew with data quality monitoring. 
21+
2. **Online feature availability:** At inference time, models often need access to features that aren't readily available and need to be precomputed from other datasources. 
2222
* Feast manages deployment to a variety of online stores (e.g. DynamoDB, Redis, Google Cloud Datastore) and ensures necessary features are consistently _available_ and _freshly computed_ at inference time.
2323
3. **Feature reusability and model versioning:** Different teams within an organization are often unable to reuse features across projects, resulting in duplicate feature creation logic. Models have data dependencies that need to be versioned, for example when running A/B tests on model versions.
24-
* Feast enables discovery of and collaboration on previously used features and enables versioning of sets of features (via _feature services_).
24+
* Feast enables discovery of and collaboration on previously used features and enables versioning of sets of features (via _feature services_). 
2525
* Feast enables feature transformation so users can re-use transformation logic across online / offline usecases and across models.
2626

2727
## Step 1: Install Feast
@@ -40,7 +40,7 @@ pip install feast
4040

4141
## Step 2: Create a feature repository
4242

43-
Bootstrap a new feature repository using `feast init` from the command line.
43+
Bootstrap a new feature repository using `feast init` from the command line. 
4444

4545
{% tabs %}
4646
{% tab title="Bash" %}
@@ -117,7 +117,7 @@ driver_hourly_stats_view = FeatureView(
117117
{% endtab %}
118118
{% endtabs %}
119119

120-
![Demo parquet data: data/driver_stats.parquet](../.gitbook/assets/screen-shot-2021-08-23-at-2.35.18-pm.png)
120+
![Demo parquet data: data/driver\_stats.parquet](../.gitbook/assets/screen-shot-2021-08-23-at-2.35.18-pm.png)
121121

122122
The key line defining the overall architecture of the feature store is the **provider**. This defines where the raw data exists (for generating training data & feature values for serving), and where to materialize feature values to in the online store (for serving).
123123

@@ -127,7 +127,7 @@ Valid values for `provider` in `feature_store.yaml` are:
127127
* gcp: use BigQuery / Google Cloud Datastore
128128
* aws: use Redshift / DynamoDB
129129

130-
A custom setup (e.g. using the built-in support for Redis) can be made by following Creating a custom provider
130+
To use a custom provider, see [adding a custom provider](../how-to-guides/creating-a-custom-provider.md). There are also several plugins maintained by the community: [Azure](https://github.com/Azure/feast-azure), [Postgres](https://github.com/nossrannug/feast-postgres), and [Hive](https://github.com/baineng/feast-hive). Note that the choice of provider gives sensible defaults but does not enforce those choices; for example, if you choose the AWS provider, you can use [Redis](../reference/online-stores/redis.md) as an online store alongside Redshift as an offline store.
131131

132132
## Step 3: Register feature definitions and deploy your feature store
133133

docs/how-to-guides/feast-gcp-aws/install-feast.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,24 @@
22

33
Install Feast using [pip](https://pip.pypa.io):
44

5-
```text
5+
```
66
pip install feast
77
```
88

9-
Install Feast with GCP dependencies \(required when using BigQuery or Firestore\):
9+
Install Feast with GCP dependencies (required when using BigQuery or Firestore):
1010

11-
```text
11+
```
1212
pip install 'feast[gcp]'
1313
```
1414

15-
Install Feast with AWS dependencies \(required when using Redshift or DynamoDB\):
15+
Install Feast with AWS dependencies (required when using Redshift or DynamoDB):
1616

17-
```text
17+
```
1818
pip install 'feast[aws]'
1919
```
2020

21+
Install Feast with Redis dependencies (required when using Redis, either through AWS Elasticache or independently):
22+
23+
```
24+
pip install 'feast[redis]'
25+
```

docs/reference/online-stores/redis.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The [Redis](https://redis.io) online store provides support for materializing feature values into Redis.
66

77
* Both Redis and Redis Cluster are supported
8-
* The data model used to store feature values in Redis is described in more detail [here](../../specs/online_store_format.md).
8+
* The data model used to store feature values in Redis is described in more detail [here](../../specs/online\_store\_format.md).
99

1010
## Examples
1111

@@ -36,4 +36,4 @@ online_store:
3636
```
3737
{% endcode %}
3838
39-
Configuration options are available [here](https://rtd.feast.dev/en/master/#feast.repo_config.RedisOnlineStoreConfig).
39+
Configuration options are available [here](https://rtd.feast.dev/en/master/#feast.infra.online\_stores.redis.RedisOnlineStoreConfig).

0 commit comments

Comments
 (0)