Skip to content

docs: Merge the feature repo docs pages #3061

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
feast-ci-bot merged 2 commits into from
Aug 10, 2022
Merged

docs: Merge the feature repo docs pages #3061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d73b2a
docs: Merge the feature repo docs pages
achals Aug 10, 2022
735bee2
delete
achals Aug 10, 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: 0 additions & 1 deletion docs/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
* [\[Alpha\] Saved dataset](getting-started/concepts/dataset.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/registry.md)
* [Offline store](getting-started/architecture-and-components/offline-store.md)
* [Online store](getting-started/architecture-and-components/online-store.md)
Expand Down
4 changes: 0 additions & 4 deletions docs/getting-started/architecture-and-components/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@
[overview.md](overview.md)
{% endcontent-ref %}

{% content-ref url="feature-repository.md" %}
[feature-repository.md](feature-repository.md)
{% endcontent-ref %}

{% content-ref url="registry.md" %}
[registry.md](registry.md)
{% endcontent-ref %}
Expand Down
27 changes: 0 additions & 27 deletions docs/getting-started/architecture-and-components/feature-repository.md
View file
Open in desktop

This file was deleted.

15 changes: 12 additions & 3 deletions docs/getting-started/concepts/feature-repo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# Feature Repository

## Feature Repo
## Feature repository
Feast users use Feast to manage two important sets of configuration:

* Configuration about how to run Feast on your infrastructure
* Feature definitions

With Feast, the above configuration can be written declaratively and stored as code in a central location. This central location is called a feature repository. The feature repository is the declarative source of truth for what the desired state of a feature store should be.

A feature repository is the collection of python files that define entities, feature views and data sources. Feature Repos also have a `feature_store.yaml` file at their root.

Users can collaborate by making and reviewing changes to Feast object definitions (feature views, entities, etc) in the feature repo.
Users can collaborate by making and reviewing changes to Feast object definitions (feature views, entities, etc.) in the feature repo.
But, these objects must be applied, either through API, or the CLI, for them to be available by downstream Feast actions (such as materialization, or retrieving online features). Internally, Feast only looks at the registry when performing these actions, and not at the feature repo directly.

## Declarative Feature Definitions

When using the CLI to apply changes (via `feast apply`), the CLI determines the state of the feature repo from the source files and updates the registry state to reflect the definitions in the feature repo files.
This means that new feature views are added to the registry, existing feature views are updated as necessary, and Feast objects removed from the source files are deleted from the registry.
This means that new feature views are added to the registry, existing feature views are updated as necessary, and Feast objects removed from the source files are deleted from the registry.

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