From 6d73b2a638fdf885735ea4de81febc9db1f58316 Mon Sep 17 00:00:00 2001 From: Achal Shah Date: Wed, 10 Aug 2022 12:18:41 -0700 Subject: [PATCH 1/2] docs: Merge the feature repo docs pages Signed-off-by: Achal Shah --- docs/SUMMARY.md | 1 - .../architecture-and-components/README.md | 4 ---- docs/getting-started/concepts/feature-repo.md | 15 ++++++++++++--- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index aa95d403680..fa1a49bc1f6 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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) diff --git a/docs/getting-started/architecture-and-components/README.md b/docs/getting-started/architecture-and-components/README.md index 6e6b5f6ee22..a67761b2fc6 100644 --- a/docs/getting-started/architecture-and-components/README.md +++ b/docs/getting-started/architecture-and-components/README.md @@ -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 %} diff --git a/docs/getting-started/concepts/feature-repo.md b/docs/getting-started/concepts/feature-repo.md index 0316019beaf..a56f42ce105 100644 --- a/docs/getting-started/concepts/feature-repo.md +++ b/docs/getting-started/concepts/feature-repo.md @@ -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. \ No newline at end of file +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. + From 735bee2f25622a96b3a63aff3cf23c0da074bbad Mon Sep 17 00:00:00 2001 From: Achal Shah Date: Wed, 10 Aug 2022 12:24:10 -0700 Subject: [PATCH 2/2] delete Signed-off-by: Achal Shah --- .../feature-repository.md | 27 ------------------- 1 file changed, 27 deletions(-) delete mode 100644 docs/getting-started/architecture-and-components/feature-repository.md diff --git a/docs/getting-started/architecture-and-components/feature-repository.md b/docs/getting-started/architecture-and-components/feature-repository.md deleted file mode 100644 index d231600eb83..00000000000 --- a/docs/getting-started/architecture-and-components/feature-repository.md +++ /dev/null @@ -1,27 +0,0 @@ -# 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. - -The Feast CLI uses the feature repository to configure, deploy, and manage your feature store. - -An example structure of a feature repository is shown below: - -```text -$ tree -a -. -├── data -│ └── driver_stats.parquet -├── driver_features.py -├── feature_store.yaml -└── .feastignore - -1 directory, 4 files -``` - -For more details, see the [Feature repository](../../reference/feature-repository/) reference. -