Skip to content

Commit 42cc91c

Browse files
achalsadchia
authored andcommitted
docs: Merge the feature repo docs pages (#3061)
* docs: Merge the feature repo docs pages Signed-off-by: Achal Shah <achals@gmail.com> * delete Signed-off-by: Achal Shah <achals@gmail.com> Signed-off-by: Achal Shah <achals@gmail.com>
1 parent 53b2c81 commit 42cc91c

File tree

4 files changed

+12
-35
lines changed

4 files changed

+12
-35
lines changed

docs/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
* [\[Alpha\] Saved dataset](getting-started/concepts/dataset.md)
2020
* [Architecture](getting-started/architecture-and-components/README.md)
2121
* [Overview](getting-started/architecture-and-components/overview.md)
22-
* [Feature repository](getting-started/architecture-and-components/feature-repository.md)
2322
* [Registry](getting-started/architecture-and-components/registry.md)
2423
* [Offline store](getting-started/architecture-and-components/offline-store.md)
2524
* [Online store](getting-started/architecture-and-components/online-store.md)

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@
44
[overview.md](overview.md)
55
{% endcontent-ref %}
66

7-
{% content-ref url="feature-repository.md" %}
8-
[feature-repository.md](feature-repository.md)
9-
{% endcontent-ref %}
10-
117
{% content-ref url="registry.md" %}
128
[registry.md](registry.md)
139
{% endcontent-ref %}

docs/getting-started/architecture-and-components/feature-repository.md

Lines changed: 0 additions & 27 deletions
This file was deleted.
Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
11
# Feature Repository
22

3-
## Feature Repo
3+
## Feature repository
4+
Feast users use Feast to manage two important sets of configuration:
5+
6+
* Configuration about how to run Feast on your infrastructure
7+
* Feature definitions
8+
9+
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.
410

511
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.
612

7-
Users can collaborate by making and reviewing changes to Feast object definitions (feature views, entities, etc) in the feature repo.
13+
Users can collaborate by making and reviewing changes to Feast object definitions (feature views, entities, etc.) in the feature repo.
814
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.
915

1016
## Declarative Feature Definitions
1117

1218
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.
13-
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.
19+
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.
20+
21+
For more details, see the [Feature repository](../../reference/feature-repository/) reference.
22+

0 commit comments

Comments
 (0)