[Alpha] Web UI
Warning: This is an experimental feature. It's intended for early testing and feedback, and could change without warnings in future releases.
Overview
The Feast Web UI allows users to explore their feature repository through a Web UI. It includes functionality such as:
Browsing Feast objects (feature views, entities, data sources, feature services, and saved datasets) and their relationships
Searching and filtering for Feast objects by tags
![](https://docs.feast.dev/~gitbook/image?url=https%3A%2F%2F3677529471-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FVkSG27xI2Nd7tq6rJzMY%252Fuploads%252Fgit-blob-360d57186d331939e2c266d30961a8fa38e17cb7%252Fui.png%3Falt%3Dmedia&width=768&dpr=4&quality=100&sign=4eaea623&sv=1)
Usage
There are several ways to use the Feast Web UI.
Feast CLI
The easiest way to get started is to run the feast ui
command within a feature repository:
Output of feast ui --help
:
This will spin up a Web UI on localhost which automatically refreshes its view of the registry every registry_ttl_sec
Importing as a module to integrate with an existing React App
This is the recommended way to use Feast UI for teams maintaining their own internal UI for their deployment of Feast.
Start with bootstrapping a React app with create-react-app
Then, in your app folder, install Feast UI and its peer dependencies. Assuming you use yarn
Edit index.js
in the React app to use Feast UI.
When you start the React app, it will look for project-list.json
to find a list of your projects. The JSON should looks something like this.
Then start the React App
Customization
The advantage of importing Feast UI as a module is in the ease of customization. The <FeastUI>
component exposes a feastUIConfigs
prop thorough which you can customize the UI. Currently it supports a few parameters.
Fetching the Project List
You can use projectListPromise
to provide a promise that overrides where the Feast UI fetches the project list from.
Custom Tabs
You can add custom tabs for any of the core Feast objects through the tabsRegistry
.
Examples of custom tabs can be found in the ui/custom-tabs
folder.
Last updated