Skip to content

Commit

Permalink
GitBook: [master] 36 pages modified
Browse files Browse the repository at this point in the history
  • Loading branch information
woop authored and gitbook-bot committed Sep 17, 2021
1 parent 3ef331d commit ecd4a66
Show file tree
Hide file tree
Showing 24 changed files with 50 additions and 64 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The best way to learn Feast is to use it. Head over to our [Quickstart](getting-
Explore the following resources to get started with Feast:

* [Quickstart](getting-started/quickstart.md) is the fastest way to get started with Feast
* [Concepts](getting-started/concepts/) describes all important Feast API concepts and Feast's overall architecture.
* [Concepts]() describes all important Feast API concepts and Feast's overall architecture.
* [Tutorials](tutorials/tutorials-overview.md) shows full examples of using Feast in machine learning applications.
* [Running Feast with GCP/AWS](how-to-guides/feast-gcp-aws/) provides a more in-depth guide to using Feast.
* [Reference](reference/feast-cli-commands.md) contains detailed API and design documents.
Expand Down
26 changes: 12 additions & 14 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,18 @@

* [Quickstart](getting-started/quickstart.md)
* [Concepts](getting-started/concepts/README.md)
* [Overview](getting-started/concepts/overview.md)
* [Data model](getting-started/concepts/data-model-and-concepts/README.md)
* [Data source](getting-started/concepts/data-model-and-concepts/data-source.md)
* [Entity](getting-started/concepts/data-model-and-concepts/entity.md)
* [Feature view](getting-started/concepts/data-model-and-concepts/feature-view.md)
* [Feature service](getting-started/concepts/data-model-and-concepts/feature-service.md)
* [Feature retrieval](getting-started/concepts/data-model-and-concepts/feature-retrieval.md)
* [Architecture](getting-started/concepts/architecture-and-components/README.md)
* [Overview](getting-started/concepts/architecture-and-components/overview.md)
* [Feature repository](getting-started/concepts/architecture-and-components/feature-repository.md)
* [Registry](getting-started/concepts/architecture-and-components/untitled.md)
* [Offline store](getting-started/concepts/architecture-and-components/offline-store.md)
* [Online store](getting-started/concepts/architecture-and-components/online-store.md)
* [Provider](getting-started/concepts/architecture-and-components/provider.md)
* [Data source](getting-started/concepts/data-source.md)
* [Entity](getting-started/concepts/entity.md)
* [Feature view](getting-started/concepts/feature-view.md)
* [Feature service](getting-started/concepts/feature-service.md)
* [Feature retrieval](getting-started/concepts/feature-retrieval.md)
* [Architecture](getting-started/architecture-and-components/README.md)
* [Overview](getting-started/architecture-and-components/overview.md)
* [Feature repository](getting-started/architecture-and-components/feature-repository.md)
* [Registry](getting-started/architecture-and-components/untitled.md)
* [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)
* [FAQ](getting-started/faq.md)

## Tutorials
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ $ tree -a
1 directory, 4 files
```

For more details, see the [Feature repository](../../../reference/feature-repository/) reference.
For more details, see the [Feature repository](../../reference/feature-repository/) reference.

Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Offline stores are used primarily for two reasons
1. Building training datasets from time-series features.
2. Materializing \(loading\) features from the offline store into an online store in order to serve those features at low latency for prediction.

Offline stores are configured through the [feature\_store.yaml](../../../reference/offline-stores/). When building training datasets or materializing features into an online store, Feast will use the configured offline store along with the data sources you have defined as part of feature views to execute the necessary data operations.
Offline stores are configured through the [feature\_store.yaml](../../reference/offline-stores/). When building training datasets or materializing features into an online store, Feast will use the configured offline store along with the data sources you have defined as part of feature views to execute the necessary data operations.

It is not possible to query all data sources from all offline stores, and only a single offline store can be used at a time. For example, it is not possible to query a BigQuery table from a `File` offline store, nor is it possible for a `BigQuery` offline store to query files from your local file system.

Please see the [Offline Stores](../../../reference/offline-stores/) reference for more details on configuring offline stores.
Please see the [Offline Stores](../../reference/offline-stores/) reference for more details on configuring offline stores.

Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The storage schema of features within the online store mirrors that of the data

Example batch data source

![](../../../.gitbook/assets/image%20%286%29.png)
![](../../.gitbook/assets/image%20%286%29.png)

Once the above data source is materialized into Feast \(using `feast materialize`\), the feature values will be stored as follows:

![](../../../.gitbook/assets/image%20%285%29.png)
![](../../.gitbook/assets/image%20%285%29.png)

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

![Feast Architecture Diagram](../../../.gitbook/assets/image%20%284%29.png)
![Feast Architecture Diagram](../../.gitbook/assets/image%20%284%29.png)

## Functionality

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A provider is an implementation of a feature store using specific feature store

Providers orchestrate various components \(offline store, online store, infrastructure, compute\) inside an environment. For example, the `gcp` provider supports [BigQuery](https://cloud.google.com/bigquery) as an offline store and [Datastore](https://cloud.google.com/datastore) as an online store, ensuring that these components can work together seamlessly. Feast has three built-in providers \(`local`, `gcp`, and `aws`\) with default configurations that make it easy for users to start a feature store in a specific environment. These default configurations can be overridden easily. For instance, you can use the `gcp` provider but use Redis as the online store instead of Datastore.

If the built-in providers are not sufficient, you can create your own custom provider. Please see [this guide](../../../how-to-guides/creating-a-custom-provider.md) for more details.
If the built-in providers are not sufficient, you can create your own custom provider. Please see [this guide](../../how-to-guides/creating-a-custom-provider.md) for more details.

Please see [feature\_store.yaml](../../../reference/feature-repository/feature-store-yaml.md#overview) for configuring providers.
Please see [feature\_store.yaml](../../reference/feature-repository/feature-store-yaml.md#overview) for configuring providers.

22 changes: 19 additions & 3 deletions docs/getting-started/concepts/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
# Concepts

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.

![](../../.gitbook/assets/image%20%287%29.png)

{% page-ref page="overview.md" %}
## Project

{% page-ref page="data-model-and-concepts/" %}
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`\).

{% page-ref page="architecture-and-components/" %}
{% hint style="info" %}
Projects are currently being supported for backward compatibility reasons. Projects may change in the future as we simplify the Feast API.
{% endhint %}

## Concepts

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

{% page-ref page="entity.md" %}

{% page-ref page="./" %}

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

{% page-ref page="feature-retrieval.md" %}



14 changes: 0 additions & 14 deletions docs/getting-started/concepts/data-model-and-concepts/README.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Feast uses a time-series data model to represent data. This data model is used t

Below is an example data source with a single entity \(`driver`\) and two features \(`trips_today`, and `rating`\).

![Ride-hailing data source](../../../.gitbook/assets/image%20%2816%29.png)
![Ride-hailing data source](../../.gitbook/assets/image%20%2816%29.png)



Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Entities should be reused across feature views.

A related concept is an entity key. These are one or more entity values that uniquely describe a feature view record. In the case of an entity \(like a `driver`\) that only has a single entity field, the entity _is_ an entity key. However, it is also possible for an entity key to consist of multiple entity values. For example, a feature view with the composite entity of \(customer, country\) might have an entity key of \(1001, 5\).

![](../../../.gitbook/assets/image%20%2815%29.png)
![](../../.gitbook/assets/image%20%2815%29.png)

Entity keys act as primary keys. They are used during the lookup of features from the online store, and they are also used to match feature rows across feature views during point-in-time joins.

Expand Down
14 changes: 0 additions & 14 deletions docs/getting-started/concepts/overview.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/getting-started/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Feature tables from Feast 0.9 have been renamed to feature views in Feast 0.10+.

### Do feature views have to include entities?

No, there are [feature views without entities](concepts/data-model-and-concepts/feature-view.md#feature-views-without-entities).
No, there are [feature views without entities](concepts/feature-view.md#feature-views-without-entities).

## Functionality

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ pprint(feature_vector)

## Next steps

* Read the [Concepts](concepts/) page to understand the Feast data model and architecture.
* Read the [Concepts]() page to understand the Feast data model and architecture.
* Check out our [Tutorials](../tutorials/tutorials-overview.md) section for more examples on how to use Feast.
* Follow our [Running Feast with GCP/AWS](../how-to-guides/feast-gcp-aws/) guide for a more in-depth tutorial on using Feast.
* Join other Feast users and contributors in [Slack](https://slack.feast.dev/) and become part of the community!
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/data-sources/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Data sources

Please see [Data Source](../../getting-started/concepts/data-model-and-concepts/feature-view.md#data-source) for an explanation of data sources.
Please see [Data Source](../../getting-started/concepts/feature-view.md#data-source) for an explanation of data sources.

{% page-ref page="file.md" %}

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/feature-repository/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,10 @@ driver_locations = FeatureView(
```
{% endcode %}

To declare new feature definitions, just add code to the feature repository, either in existing files or in a new file. For more information on how to define features, see [Feature Views](../../getting-started/concepts/data-model-and-concepts/#feature-view).
To declare new feature definitions, just add code to the feature repository, either in existing files or in a new file. For more information on how to define features, see [Feature Views](../../getting-started/concepts/#feature-view).

### Next steps

* See [Create a feature repository](../../how-to-guides/feast-gcp-aws/create-a-feature-repository.md) to get started with an example feature repository.
* See [feature\_store.yaml](feature-store-yaml.md), [.feastignore](feast-ignore.md), or [Feature Views](../../getting-started/concepts/data-model-and-concepts/#feature-view) for more information on the configuration files that live in a feature registry.
* See [feature\_store.yaml](feature-store-yaml.md), [.feastignore](feast-ignore.md), or [Feature Views](../../getting-started/concepts/#feature-view) for more information on the configuration files that live in a feature registry.

2 changes: 1 addition & 1 deletion docs/reference/offline-stores/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Offline stores

Please see [Offline Store](../../getting-started/concepts/architecture-and-components/offline-store.md) for an explanation of offline stores.
Please see [Offline Store](../../getting-started/architecture-and-components/offline-store.md) for an explanation of offline stores.

{% page-ref page="file.md" %}

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/online-stores/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Online stores

Please see [Online Store](../../getting-started/concepts/architecture-and-components/online-store.md) for an explanation of online stores.
Please see [Online Store](../../getting-started/architecture-and-components/online-store.md) for an explanation of online stores.

{% page-ref page="sqlite.md" %}

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/providers/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Providers

Please see [Provider](../../getting-started/concepts/architecture-and-components/provider.md) for an explanation of providers.
Please see [Provider](../../getting-started/architecture-and-components/provider.md) for an explanation of providers.

{% page-ref page="local.md" %}

Expand Down

0 comments on commit ecd4a66

Please sign in to comment.