Skip to content

Commit e612593

Browse files
committed
Repair README.md
1 parent b724cf8 commit e612593

1 file changed

Lines changed: 75 additions & 65 deletions

File tree

README.md

Lines changed: 75 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,78 @@
1-
# Initial page
2-
3-
{% api-method method="get" host="https://api.cakes.com" path="/v1/cakes/:id" %}
4-
{% api-method-summary %}
5-
Get Cakes
6-
{% endapi-method-summary %}
7-
8-
{% api-method-description %}
9-
This endpoint allows you to get free cakes.
10-
{% endapi-method-description %}
11-
12-
{% api-method-spec %}
13-
{% api-method-request %}
14-
{% api-method-path-parameters %}
15-
{% api-method-parameter name="id" type="string" %}
16-
ID of the cake to get, for free of course.
17-
{% endapi-method-parameter %}
18-
{% endapi-method-path-parameters %}
19-
20-
{% api-method-headers %}
21-
{% api-method-parameter name="Authentication" type="string" required=true %}
22-
Authentication token to track down who is emptying our stocks.
23-
{% endapi-method-parameter %}
24-
{% endapi-method-headers %}
25-
26-
{% api-method-query-parameters %}
27-
{% api-method-parameter name="recipe" type="string" %}
28-
The API will do its best to find a cake matching the provided recipe.
29-
{% endapi-method-parameter %}
30-
31-
{% api-method-parameter name="gluten" type="boolean" %}
32-
Whether the cake should be gluten-free or not.
33-
{% endapi-method-parameter %}
34-
{% endapi-method-query-parameters %}
35-
{% endapi-method-request %}
36-
37-
{% api-method-response %}
38-
{% api-method-response-example httpCode=200 %}
39-
{% api-method-response-example-description %}
40-
Cake successfully retrieved.
41-
{% endapi-method-response-example-description %}
42-
43-
```javascript
44-
{
45-
"name": "Cake's name",
46-
"recipe": "Cake's recipe name",
47-
"cake": "Binary cake"
48-
}
49-
```
50-
{% endapi-method-response-example %}
51-
52-
{% api-method-response-example httpCode=404 %}
53-
{% api-method-response-example-description %}
54-
Could not find a cake matching this query.
55-
{% endapi-method-response-example-description %}
56-
57-
```javascript
58-
{
59-
"message": "Ain't no cake like that."
60-
}
61-
```
62-
{% endapi-method-response-example %}
63-
{% endapi-method-response %}
64-
{% endapi-method-spec %}
65-
{% endapi-method %}
1+
# Feast - Feature Store for Machine Learning [![Build Status](http://prow.feast.ai/badge.svg?jobs=integration-test)](http://prow.feast.ai)
662

3+
## Overview
674

5+
Feast (Feature Store) is a tool to manage storage and access of machine learning features.
686

7+
It aims to:
8+
* Support ingesting feature data via batch or streaming
9+
* Provide scalable storage of feature data for serving and training
10+
* Provide an API for low latency access of features
11+
* Enable discovery and documentation of features
12+
* Provide an overview of the general health of features in the system
13+
14+
## High Level Architecture
15+
16+
![Feast Architecture](docs/architecture.png)
17+
18+
The Feast platform is broken down into the following functional areas:
19+
20+
* __Create__ features based on defined format and programming model
21+
* __Ingest__ features via streaming input, import from files or BigQuery tables, and write to an appropriate data store
22+
* __Store__ feature data for both serving and training purposes based on feature access patterns
23+
* __Access__ features for training and serving
24+
* __Discover__ information about entities and features stored and served by Feast
25+
26+
## Motivation
27+
28+
__Access to features in serving__: Machine learning models typically require access to features created in both batch pipelines, and real time streams. Feast provides a means for accessing these features in a serving environment, at low latency and high load.
29+
30+
__Consistency between training and serving__: In many machine learning systems there exists a disconnect between features that are created in batch pipelines for the training of a model, and ones that are created from streams for the serving of real-time features. By centralizing the ingestion of features, Feast provides a consistent view of both batch and real-time features, in both training and serving.
31+
32+
__Infrastructure management__: Feast abstracts away much of the engineering overhead associated with managing data infrastructure. It handles the ingestion, storage, and serving of large amount of feature data in a scalable way. The system configures data models based on your registered feature specifications, and ensures that you always have a consistent view of features in both your historical and real-time data stores.
33+
34+
__Feature standardisation__: Feast presents a centralized platform on which teams can register features in a standardized way using specifications. This provides structure to the way features are defined and allows teams to reference features in discussions with a singly understood link.
35+
36+
__Discovery__: Feast allows users to easily explore and discover features and their associated information. This allows for a deeper understanding of features and theirs specifications, more feature reuse between teams and projects, and faster experimentation. Each new ML project can leverage features that have been created by prior teams, which compounds an organization's ability to discover new insights.
37+
38+
## More Information
39+
40+
* [Components](docs/components.md)
41+
* [Concepts](docs/concepts.md)
42+
43+
For Feast administrators:
44+
* [Installation quickstart](docs/install.md)
45+
* [Helm charts](charts/README.md) details
46+
47+
For Feast end users:
48+
* [Creating features](docs/endusers.md)
49+
50+
For Feast developers:
51+
* [Building the CLI](cli/README.md)
52+
53+
## Notice
54+
55+
Feast is still under active development. Your feedback and contributions are important to us. Please check our [contributing guide](CONTRIBUTING.md) for details.
56+
57+
## Source Code Headers
58+
59+
Every file containing source code must include copyright and license
60+
information. This includes any JS/CSS files that you might be serving out to
61+
browsers. (This is to help well-intentioned people avoid accidental copying that
62+
doesn't comply with the license.)
63+
64+
Apache header:
65+
66+
Copyright 2018 The Feast Authors
67+
68+
Licensed under the Apache License, Version 2.0 (the "License");
69+
you may not use this file except in compliance with the License.
70+
You may obtain a copy of the License at
71+
72+
https://www.apache.org/licenses/LICENSE-2.0
73+
74+
Unless required by applicable law or agreed to in writing, software
75+
distributed under the License is distributed on an "AS IS" BASIS,
76+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
77+
See the License for the specific language governing permissions and
78+
limitations under the License.

0 commit comments

Comments
 (0)