Skip to content

Commit 3eb7232

Browse files
WingCodewoop
andauthored
Fix wrong description in README.md (#1779)
* GitBook: [v0.12-branch] 90 pages and 7 assets modified * Fix README.md The wording is wrong. Low latency is from online-store since it is in-memory Co-authored-by: Willem Pienaar <github@willem.co>
1 parent 8ef2053 commit 3eb7232

39 files changed

+267
-322
lines changed

docs/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What is Feast?
44

5-
Feast \(**Fea**ture **St**ore\) is an operational data system for managing and serving machine learning features to models in production. It can serve features from a low-latency offline store \(for real-time prediction\) or from an off-line store \(for scale-out batch scoring or training models\).
5+
Feast \(**Fea**ture **St**ore\) is an operational data system for managing and serving machine learning features to models in production. It can serve features from a low-latency online store \(for real-time prediction\) or from an off-line store \(for scale-out batch scoring or training models\).
66

77
![](.gitbook/assets/feast_hero_010.png)
88

@@ -54,5 +54,3 @@ Explore the following resources to get started with Feast:
5454
* [Reference](reference/feast-cli-commands.md) contains detailed API and design documents.
5555
* [Contributing](contributing/contributing.md) contains resources for anyone who wants to contribute to Feast.
5656

57-
58-

docs/concepts/architecture-and-components.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Feast Architecture Diagram](../.gitbook/assets/image%20%284%29.png)
44

5-
#### Functionality
5+
## Functionality
66

77
* **Create Batch Features:** ELT/ETL systems like Spark and SQL are used to transform data in the batch store.
88
* **Feast Apply:** The user \(or CI\) publishes versioned controlled feature definitions using `feast apply`. This CLI command updates infrastructure and persists definitions in the object store registry.
@@ -13,7 +13,7 @@
1313
* **Prediction:** A backend system makes a request for a prediction from the model serving service.
1414
* **Get Online Features:** The model serving service makes a request to the Feast Online Serving service for online features using a Feast SDK.
1515

16-
#### Components
16+
## Components
1717

1818
A complete Feast deployment contains the following components:
1919

docs/concepts/overview.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# Overview
22

3-
The top-level namespace within Feast is a [project](data-model-and-concepts.md#project). Users define one or more [feature views](data-model-and-concepts.md#feature-view) within a project. Each feature view contains one or more [features](data-model-and-concepts.md#feature) that relate to a specific [entity](data-model-and-concepts.md#entity). A feature view must always have a [data source](data-model-and-concepts.md#data-source), which in turn is used during the generation of training [datasets](data-model-and-concepts.md#dataset) and when materializing feature values into the online store.
3+
The top-level namespace within Feast is a [project](data-model-and-concepts.md#project). Users define one or more [feature views](data-model-and-concepts.md#feature-view) within a project. Each feature view contains one or more [features](data-model-and-concepts.md#feature) that relate to a specific [entity](data-model-and-concepts.md#entity). A feature view must always have a [data source](data-model-and-concepts.md#data-source), which in turn is used during the generation of training [datasets](data-model-and-concepts.md#dataset) and when materializing feature values into the online store.
44

55
![](../.gitbook/assets/image%20%287%29.png)
66

7-
### Project
7+
## Project
88

99
Projects provide complete isolation of feature stores at the infrastructure level. This is accomplished through resource namespacing, e.g., prefixing table names with the associated project. Each project should be considered a completely separate universe of entities and features. It is not possible to retrieve features from multiple projects in a single request. We recommend having a single feature store and a single project per environment \(`dev`, `staging`, `prod`\).
1010

1111
{% hint style="info" %}
1212
Projects are currently being supported for backward compatibility reasons. Projects may change in the future as we simplify the Feast API.
1313
{% endhint %}
1414

15-
###
16-

docs/contributing/development-guide.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ Feast is composed of [multiple components](https://docs.feast.dev/v/master/conce
9292

9393
## Making a Pull Request
9494

95-
#### Incorporating upstream changes from master
95+
### Incorporating upstream changes from master
9696

9797
Our preference is the use of `git rebase` instead of `git merge` : `git pull -r`
9898

99-
#### Signing commits
99+
### Signing commits
100100

101101
Commits have to be signed before they are allowed to be merged into the Feast codebase:
102102

@@ -105,7 +105,7 @@ Commits have to be signed before they are allowed to be merged into the Feast co
105105
git commit -s -m "My first commit"
106106
```
107107

108-
#### Good practices to keep in mind
108+
### Good practices to keep in mind
109109

110110
* Fill in the description based on the default template configured when you first open the PR
111111
* What this PR does/why we need it
@@ -136,7 +136,7 @@ Feast Protobuf API defines the common API used by Feast's Components:
136136
* Feast Protobuf API specifications are written in [proto3](https://developers.google.com/protocol-buffers/docs/proto3) in the Main Feast Repository.
137137
* Changes to the API should be proposed via a [GitHub Issue](https://github.com/feast-dev/feast/issues/new/choose) for discussion first.
138138

139-
#### Generating Language Bindings
139+
### Generating Language Bindings
140140

141141
The language specific bindings have to be regenerated when changes are made to the Feast Protobuf API:
142142

@@ -146,5 +146,3 @@ The language specific bindings have to be regenerated when changes are made to t
146146
| [Main Feast Repository](https://github.com/feast-dev/feast) | Golang | Run `make compile-protos-go` to generate bindings |
147147
| [Feast Java](https://github.com/feast-dev/feast-java) | Java | No action required: bindings are generated automatically during compilation. |
148148

149-
####
150-

docs/contributing/release-process.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ When a tag that matches a Semantic Version string is pushed, CI will automatical
2828

2929
### Creating a change log
3030

31-
We use an [open source change log generator](https://hub.docker.com/r/ferrarimarco/github-changelog-generator/) to generate change logs. The process still requires a little bit of manual effort.
31+
We use an [open source change log generator](https://hub.docker.com/r/ferrarimarco/github-changelog-generator/) to generate change logs. The process still requires a little bit of manual effort.
3232

3333
1. Create a GitHub token as [per these instructions](https://github.com/github-changelog-generator/github-changelog-generator#github-token). The token is used as an input argument \(`-t`\) to the change log generator.
3434
2. The change log generator configuration below will look for unreleased changes on a specific branch. The branch will be `master` for a major/minor release, or a release branch \(`v0.4-branch`\) for a patch release. You will need to set the branch using the `--release-branch` argument.
@@ -61,5 +61,5 @@ docker run -it --rm ferrarimarco/github-changelog-generator \
6161

6262
It's important to flag breaking changes and deprecation to the API for each release so that we can maintain API compatibility.
6363

64-
Developers should have flagged PRs with breaking changes with the `compat/breaking` label. However, it's important to double check each PR's release notes and contents for changes that will break API compatibility and manually label `compat/breaking` to PRs with undeclared breaking changes. The change log will have to be regenerated if any new labels have to be added.
64+
Developers should have flagged PRs with breaking changes with the `compat/breaking` label. However, it's important to double check each PR's release notes and contents for changes that will break API compatibility and manually label `compat/breaking` to PRs with undeclared breaking changes. The change log will have to be regenerated if any new labels have to be added.
6565

docs/contributing/versioning-policy.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Versioning policies and status of Feast components
44

55
# Versioning policy
66

7-
### Versioning policy and branch workflow
7+
## Versioning policy and branch workflow
88

99
Feast uses [semantic versioning](https://semver.org/).
1010

@@ -19,9 +19,9 @@ A release branch should be substantially _feature complete_ with respect to the
1919

2020
In general, unless you're committing code that only applies to a particular release stream \(for example, temporary hot-fixes, back-ported security fixes, or image hashes\), you should base changes from `master` and then merge or cherry-pick to the release branch.
2121

22-
### Feast Component Matrix
22+
## Feast Component Matrix
2323

24-
The following table shows the **status** \(stable, beta, or alpha\) of Feast components.
24+
The following table shows the **status** \(stable, beta, or alpha\) of Feast components.
2525

2626
Application status indicators for Feast:
2727

@@ -59,7 +59,7 @@ Criteria for reaching **beta** status
5959
* API reference documentation
6060
* Deprecative changes must span multiple minor versions and allow for an upgrade path.
6161

62-
### Levels of support <a id="levels-of-support"></a>
62+
## Levels of support <a id="levels-of-support"></a>
6363

6464
Feast components have various levels of support based on the component status.
6565

@@ -69,7 +69,7 @@ Feast components have various levels of support based on the component status.
6969
| Beta | The Feast community offers best-effort support for beta applications. Beta applications will be supported for at least 2 more minor releases. |
7070
| Alpha | The response differs per application in alpha status, depending on the size of the community for that application and the current level of active development of the application. |
7171

72-
### Support from the Feast community <a id="support-from-the-kubeflow-community"></a>
72+
## Support from the Feast community <a id="support-from-the-kubeflow-community"></a>
7373

7474
Feast has an active and helpful community of users and contributors.
7575

docs/feast-on-kubernetes-1/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,3 @@
44
Since Feast 0.10, it is not necessary to deploy Feast into Kubernetes any more. Feast runs as a light weight CLI/SDK that can configure your managed services to operate as a feature store. The documentation contained within this section exists for posterity sake and relates to Feast 0.9, which depends on both Kubernetes and Spark. Teams that want to consume from streaming sources have to continue to use this release until streaming support has been reintroduced to Feast.
55
{% endhint %}
66

7-
8-

0 commit comments

Comments
 (0)