Skip to content

Commit d0a2443

Browse files
adchiagitbook-bot
adchia
authored and
gitbook-bot
committed
GitBook: [master] 6 pages modified
1 parent 463b88f commit d0a2443

File tree

6 files changed

+24
-17
lines changed

6 files changed

+24
-17
lines changed

‎docs/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ The best way to learn Feast is to use it. Head over to our [Quickstart](getting-
4949
Explore the following resources to get started with Feast:
5050

5151
* [Quickstart](getting-started/quickstart.md) is the fastest way to get started with Feast
52-
* [Concepts]() describes all important Feast API concepts and Feast's overall architecture.
52+
* [Concepts](getting-started/concepts/) describes all important Feast API concepts
53+
* [Architecture](getting-started/architecture-and-components/) describes Feast's overall architecture.
5354
* [Tutorials](tutorials/tutorials-overview.md) shows full examples of using Feast in machine learning applications.
5455
* [Running Feast with GCP/AWS](how-to-guides/feast-gcp-aws/) provides a more in-depth guide to using Feast.
5556
* [Reference](reference/feast-cli-commands.md) contains detailed API and design documents.

‎docs/SUMMARY.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
* [Quickstart](getting-started/quickstart.md)
1111
* [Concepts](getting-started/concepts/README.md)
12+
* [Overview](getting-started/concepts/overview.md)
1213
* [Data source](getting-started/concepts/data-source.md)
1314
* [Entity](getting-started/concepts/entity.md)
1415
* [Feature view](getting-started/concepts/feature-view.md)

‎docs/getting-started/architecture-and-components/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
{% page-ref page="feature-repository.md" %}
66

7+
{% page-ref page="untitled.md" %}
8+
79
{% page-ref page="offline-store.md" %}
810

911
{% page-ref page="online-store.md" %}

‎docs/getting-started/concepts/README.md‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,12 @@
11
# Concepts
22

3-
The top-level namespace within Feast is a [project](). Users define one or more [feature views](feature-view.md) within a project. Each feature view contains one or more [features](feature-view.md#feature). These features typically relate to one or more [entities](entity.md). A feature view must always have a [data source](data-source.md), which in turn is used during the generation of training [datasets](feature-retrieval.md#dataset) and when materializing feature values into the online store.
4-
5-
![](../../.gitbook/assets/image%20%287%29.png)
6-
7-
## Project
8-
9-
Projects provide complete isolation of feature stores at the infrastructure level. This is accomplished through resource namespacing, e.g., prefixing table names with the associated project. Each project should be considered a completely separate universe of entities and features. It is not possible to retrieve features from multiple projects in a single request. We recommend having a single feature store and a single project per environment \(`dev`, `staging`, `prod`\).
10-
11-
{% hint style="info" %}
12-
Projects are currently being supported for backward compatibility reasons. Projects may change in the future as we simplify the Feast API.
13-
{% endhint %}
14-
15-
## Concepts
3+
{% page-ref page="overview.md" %}
164

175
{% page-ref page="data-source.md" %}
186

19-
{% page-ref page="entity.md" %}
7+
{% page-ref page="feature-view.md" %}
208

21-
{% page-ref page="./" %}
9+
{% page-ref page="entity.md" %}
2210

2311
{% page-ref page="feature-service.md" %}
2412

‎docs/getting-started/concepts/overview.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Overview
2+
3+
The top-level namespace within Feast is a [project](overview.md#project). Users define one or more [feature views](feature-view.md) within a project. Each feature view contains one or more [features](feature-view.md#feature). These features typically relate to one or more [entities](entity.md). A feature view must always have a [data source](data-source.md), which in turn is used during the generation of training [datasets](feature-retrieval.md#dataset) and when materializing feature values into the online store.
4+
5+
![](../../.gitbook/assets/image%20%287%29.png)
6+
7+
## Project
8+
9+
Projects provide complete isolation of feature stores at the infrastructure level. This is accomplished through resource namespacing, e.g., prefixing table names with the associated project. Each project should be considered a completely separate universe of entities and features. It is not possible to retrieve features from multiple projects in a single request. We recommend having a single feature store and a single project per environment \(`dev`, `staging`, `prod`\).
10+
11+
{% hint style="info" %}
12+
Projects are currently being supported for backward compatibility reasons. Projects may change in the future as we simplify the Feast API.
13+
{% endhint %}
14+

‎docs/getting-started/quickstart.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,8 @@ pprint(feature_vector)
342342

343343
## Next steps
344344

345-
* Read the [Concepts]() page to understand the Feast data model and architecture.
345+
* Read the [Concepts](concepts/) page to understand the Feast data model.
346+
* Read the [Architecture](architecture-and-components/) page.
346347
* Check out our [Tutorials](../tutorials/tutorials-overview.md) section for more examples on how to use Feast.
347348
* Follow our [Running Feast with GCP/AWS](../how-to-guides/feast-gcp-aws/) guide for a more in-depth tutorial on using Feast.
348349
* Join other Feast users and contributors in [Slack](https://slack.feast.dev/) and become part of the community!

0 commit comments

Comments
 (0)