From e895bc46deb827dd320d778893bd5f9f0e1c2906 Mon Sep 17 00:00:00 2001 From: Willem Pienaar Date: Tue, 31 Aug 2021 16:51:21 +0000 Subject: [PATCH] GitBook: [master] 2 pages modified --- docs/SUMMARY.md | 1 + .../architecture-and-components/untitled.md | 30 +++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 docs/getting-started/concepts/architecture-and-components/untitled.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index af87142770..98f256ced7 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -19,6 +19,7 @@ * [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) diff --git a/docs/getting-started/concepts/architecture-and-components/untitled.md b/docs/getting-started/concepts/architecture-and-components/untitled.md new file mode 100644 index 0000000000..6bbef98d17 --- /dev/null +++ b/docs/getting-started/concepts/architecture-and-components/untitled.md @@ -0,0 +1,30 @@ +# Registry + +The Feast feature registry is a central catalog of all the feature definitions and their related metadata. It allows data scientists to search, discover, and collaborate on new features. + +Each Feast deployment has a single feature registry. Feast only supports file-based registries today, but supports three different backends + +* `Local`: Used as a local backend for storing the registry during development +* `S3`: Used as a centralized backend for storing the registry on AWS +* `GCS`: Used as a centralized backend for storing the registry on GCP + +The feature registry is updated during different operations when using Feast. More specifically, objects within the registry \(entities, feature views, feature services\) are updated when running `apply` from the Feast CLI, but metadata about objects can also be updated during operations like materialization. + +Users interact with a feature registry through the Feast SDK. Listing all feature views: + +```python +fs = FeatureStore("my_feature_repo/") +print(fs.list_feature_views()) +``` + +Or retrieving a specific feature view: + +```python +fs = FeatureStore("my_feature_repo/") +fv = fs.get_feature_view(“my_fv1”) +``` + +{% hint style="info" %} +The feature registry is a [Protobuf representation](https://github.com/feast-dev/feast/blob/master/protos/feast/core/Registry.proto) of Feast metadata. This Protobuf file can be read programmatically from other programming languages, but no compatibility guarantees are made on the internal structure of the registry. +{% endhint %} +