Skip to content

Commit e8a5a4c

Browse files
committed
docs: Fixed documentation
Signed-off-by: ntkathole <nikhilkathole2683@gmail.com>
1 parent ec272d5 commit e8a5a4c

7 files changed

Lines changed: 55 additions & 22 deletions

File tree

.gitbook.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@ structure:
66
redirects:
77
reference/telemetry: ./reference/usage.md
88
quickstart: ./getting-started/quickstart.md
9+
reference/feature-store-yaml: ./reference/feature-repository/feature-store-yaml.md
10+
reference/feast-ignore: ./reference/feature-repository/feast-ignore.md
11+
reference/feature-repository: ./reference/feature-repository/README.md

docs/SUMMARY.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,12 @@
2323
* [Project](getting-started/concepts/project.md)
2424
* [Data ingestion](getting-started/concepts/data-ingestion.md)
2525
* [Entity](getting-started/concepts/entity.md)
26+
* [Data types](getting-started/concepts/feast-types.md)
27+
* [Feature repository](getting-started/concepts/feature-repo.md)
2628
* [Feature view](getting-started/concepts/feature-view.md)
29+
* [Batch feature view](getting-started/concepts/batch-feature-view.md)
30+
* [Stream feature view](getting-started/concepts/stream-feature-view.md)
31+
* [Tiling with Intermediate Representations](getting-started/concepts/tiling.md)
2732
* [Label view](getting-started/concepts/label-view.md)
2833
* [Feature retrieval](getting-started/concepts/feature-retrieval.md)
2934
* [Point-in-time joins](getting-started/concepts/point-in-time-joins.md)
@@ -38,6 +43,7 @@
3843
* [Online store](getting-started/components/online-store.md)
3944
* [Feature server](getting-started/components/feature-server.md)
4045
* [Compute Engine](getting-started/components/compute-engine.md)
46+
* [Stream Processor](getting-started/components/stream-processor.md)
4147
* [Provider](getting-started/components/provider.md)
4248
* [Authorization Manager](getting-started/components/authz_manager.md)
4349
* [OpenTelemetry Integration](getting-started/components/open-telemetry.md)
@@ -85,13 +91,14 @@
8591
* [Feast Production Deployment Topologies](how-to-guides/production-deployment-topologies.md)
8692
* [Online Server Performance Tuning](how-to-guides/online-server-performance-tuning.md)
8793
* [Customizing Feast](how-to-guides/customizing-feast/README.md)
88-
* [Adding a custom batch materialization engine](how-to-guides/customizing-feast/creating-a-custom-materialization-engine.md)
94+
* [Adding a custom compute engine](how-to-guides/customizing-feast/creating-a-custom-compute-engine.md)
8995
* [Adding a new offline store](how-to-guides/customizing-feast/adding-a-new-offline-store.md)
9096
* [Adding a new online store](how-to-guides/customizing-feast/adding-support-for-a-new-online-store.md)
9197
* [Adding a custom provider](how-to-guides/customizing-feast/creating-a-custom-provider.md)
9298
* [Adding or reusing tests](how-to-guides/adding-or-reusing-tests.md)
9399
* [Starting Feast servers in TLS(SSL) Mode](how-to-guides/starting-feast-servers-tls-mode.md)
94100
* [Importing Features from dbt](how-to-guides/dbt-integration.md)
101+
* [Entity Key Serialization (v2 to v3)](how-to-guides/entity-reserialization-of-from-v2-to-v3.md)
95102
* [Feature Quality Monitoring](how-to-guides/feature-monitoring.md)
96103

97104
## Reference
@@ -162,12 +169,15 @@
162169
* [Faiss](reference/online-stores/faiss.md)
163170
* [Hybrid](reference/online-stores/hybrid.md)
164171
* [Registries](reference/registries/README.md)
172+
* [Metadata](reference/registries/metadata.md)
165173
* [Local](reference/registries/local.md)
166174
* [S3](reference/registries/s3.md)
167175
* [GCS](reference/registries/gcs.md)
168176
* [SQL](reference/registries/sql.md)
169177
* [Snowflake](reference/registries/snowflake.md)
178+
* [HDFS](reference/registries/hdfs.md)
170179
* [Remote](reference/registries/remote.md)
180+
* [Registry permissions](reference/registry/registry-permissions.md)
171181
* [Providers](reference/providers/README.md)
172182
* [Local](reference/providers/local.md)
173183
* [Google Cloud Platform](reference/providers/google-cloud-platform.md)
@@ -182,6 +192,9 @@
182192
* [Feature repository](reference/feature-repository/README.md)
183193
* [feature\_store.yaml](reference/feature-repository/feature-store-yaml.md)
184194
* [.feastignore](reference/feature-repository/feast-ignore.md)
195+
* [Registration inferencing](reference/feature-repository/registration-inferencing.md)
196+
* [Kubernetes auth setup](reference/auth/kubernetes_auth_setup.md)
197+
* [User token provisioning](reference/auth/user_token_provisioning.md)
185198
* [Feature servers](reference/feature-servers/README.md)
186199
* [Python feature server](reference/feature-servers/python-feature-server.md)
187200
* [\[Alpha\] Go feature server](reference/feature-servers/go-feature-server.md)
@@ -222,3 +235,4 @@
222235
* [ADR-0009: Contribution and Extensibility](adr/ADR-0009-contribution-extensibility.md)
223236
* [ADR-0010: Vector Database Integration](adr/ADR-0010-vector-database-integration.md)
224237
* [ADR-0011: Data Quality Monitoring](adr/ADR-0011-data-quality-monitoring.md)
238+
* [ADR-0012: LabelView](adr/ADR-0012-label-view.md)

docs/getting-started/components/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@
2020
[compute-engine.md](compute-engine.md)
2121
{% endcontent-ref %}
2222

23+
{% content-ref url="stream-processor.md" %}
24+
[stream-processor.md](stream-processor.md)
25+
{% endcontent-ref %}
26+
2327
{% content-ref url="provider.md" %}
2428
[provider.md](provider.md)
2529
{% endcontent-ref %}

docs/getting-started/concepts/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@
1616
[entity.md](entity.md)
1717
{% endcontent-ref %}
1818

19+
{% content-ref url="feast-types.md" %}
20+
[feast-types.md](feast-types.md)
21+
{% endcontent-ref %}
22+
23+
{% content-ref url="feature-repo.md" %}
24+
[feature-repo.md](feature-repo.md)
25+
{% endcontent-ref %}
26+
1927
{% content-ref url="feature-view.md" %}
2028
[feature-view.md](feature-view.md)
2129
{% endcontent-ref %}
@@ -44,6 +52,10 @@
4452
[dataset.md](dataset.md)
4553
{% endcontent-ref %}
4654

55+
{% content-ref url="label-view.md" %}
56+
[label-view.md](label-view.md)
57+
{% endcontent-ref %}
58+
4759
{% content-ref url="permission.md" %}
4860
[permission.md](permission.md)
4961
{% endcontent-ref %}

docs/getting-started/concepts/label-view.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Before using label views, you need:
3030

3131
**Generate training datasets.** Compose label views with feature views in a `FeatureService` and retrieve features + labels together with point-in-time correctness.
3232

33-
**Annotate in the UI.** Configure annotation profiles so data scientists can label data directly in the Feast UI — entity forms, document spans, bulk review, or active learning.
33+
**Data label in the UI.** Configure data labeling profiles (annotation profiles) so data scientists can label data directly in the Feast UI — entity forms, document spans, bulk review, or active learning.
3434

3535
## Feedback vs Expectations
3636

@@ -85,10 +85,10 @@ store.push("agent_feedback_labels_push_source", labels_df)
8585

8686
| Use a **FeatureView** when… | Use a **LabelView** when… |
8787
|---|---|
88-
| Data is observational and append-only | Data is a judgment or annotation |
88+
| Data is observational and append-only | Data is a judgment or data label (annotation) |
8989
| One source writes the data | Multiple labelers may disagree |
9090
| No conflict resolution needed | You need governed conflict resolution |
91-
| No labeling UI needed | You want structured annotation workflows |
91+
| No labeling UI needed | You want structured data labeling workflows (annotation) |
9292

9393
## How Label Views Work
9494

@@ -164,14 +164,14 @@ store.push("agent_feedback_labels_push_source", labels_df)
164164

165165
Each push appends to the offline store (full history retained) and updates the online store (latest value per key).
166166

167-
### Step 3: Annotate in the Feast UI
167+
### Step 3: Data label in the Feast UI
168168

169-
Open the label view in the Feast UI **Annotate** tab. The UI reads annotation tags and shows the right workflow:
169+
Open the label view in the Feast UI **Data Labeling** tab (Annotate tab). The UI reads data labeling tags (annotation tags) and shows the right workflow:
170170

171171
1. Open **Label Views** in the sidebar
172-
2. Select a label view (check the **Annotation** badge on the list page)
173-
3. Go to the **Annotate** tab
174-
4. Choose a method (Entity Form, Document Span, Review & Edit, or Active Learning)
172+
2. Select a label view (check the **Data Labeling** badge on the list page)
173+
3. Go to the **Data Labeling** tab (Annotate tab)
174+
4. Choose a data labeling method (annotation method): Entity Form, Document Span, Review & Edit, or Active Learning
175175
5. Submit labels — they are pushed to the label view's `PushSource`
176176

177177
### Step 4: Join labels with features for training
@@ -193,16 +193,16 @@ training_df = store.get_historical_features(
193193

194194
Training pipelines get features and resolved labels in one retrieval call.
195195

196-
## Annotation Profiles
196+
## Data Labeling Profiles (Annotation Profiles)
197197

198-
Annotation profiles configure **how** labels are created in the UI. Set them via `tags` — no schema changes required.
198+
Data labeling profiles (annotation profiles) configure **how** labels are created in the UI. Set them via `tags` — no schema changes required.
199199

200200
### Supported profiles
201201

202202
| Profile | Best for | UI experience |
203203
|---|---|---|
204204
| `entity-form` | RLHF, safety review, per-entity feedback | Form — one entity at a time |
205-
| `document-span` | RAG chunk labeling, span annotation | Load document, label chunks |
205+
| `document-span` | RAG chunk labeling, span labeling (annotation) | Load document, label chunks |
206206
| `table` | Bulk review, correcting existing labels | Editable table with dropdowns |
207207
| `active-learning` | Label high-value unlabeled entities | Queue from a reference feature view |
208208

@@ -215,7 +215,7 @@ Answer one question:
215215
3. **"I need to correct labels in bulk"**`table`
216216
4. **"I want to label only the most valuable unlabeled items"**`active-learning` (requires `reference_feature_view`)
217217

218-
The **Annotate** tab shows only relevant methods per profile:
218+
The **Data Labeling** tab (Annotate tab) shows only relevant data labeling methods (annotation methods) per profile:
219219

220220
| Profile | Methods shown |
221221
|---|---|
@@ -228,7 +228,7 @@ The **Annotate** tab shows only relevant methods per profile:
228228

229229
| Tag | Purpose | Example values |
230230
|---|---|---|
231-
| `feast.io/labeling-method` | Primary UI workflow | `entity-form`, `document-span`, `table` |
231+
| `feast.io/labeling-method` | Primary data labeling method (annotation method) | `entity-form`, `document-span`, `table` |
232232
| `feast.io/field-role:<field>` | Semantic role of a field | `feedback`, `expectation`, `label`, `metadata`, `content`, `span_start`, `span_end` |
233233
| `feast.io/label-values:<field>` | Allowed label values | `relevant,irrelevant` |
234234
| `feast.io/label-widget:<field>` | Input widget type | `enum`, `binary`, `text`, `number` |
@@ -325,7 +325,7 @@ When multiple labelers write different values for the same entity, `ConflictPoli
325325
|---|---|
326326
| `LAST_WRITE_WINS` | Default. Most recent write wins. |
327327
| `LABELER_PRIORITY` | Trusted labelers override others (e.g. human over LLM judge). |
328-
| `MAJORITY_VOTE` | Consensus labeling (e.g. multiple annotators on RAG chunks). |
328+
| `MAJORITY_VOTE` | Consensus labeling (e.g. multiple labelers on RAG chunks). |
329329

330330
{% hint style="info" %}
331331
Conflict policies apply to the **offline store** (training). The **online store** always uses last-write-wins. Full label history is always retained in the offline store.
@@ -337,20 +337,20 @@ Conflict policies apply to the **offline store** (training). The **online store*
337337

338338
**Tag field roles.** Set `feast.io/field-role:<field>` to `feedback` or `expectation` so your team and UI know what each field means.
339339

340-
**Match conflict policy to label type.** Use `LABELER_PRIORITY` when humans correct automated judges. Use `MAJORITY_VOTE` for multi-annotator consensus. Use `LAST_WRITE_WINS` for simple feedback streams.
340+
**Match conflict policy to label type.** Use `LABELER_PRIORITY` when humans correct automated judges. Use `MAJORITY_VOTE` for multi-labeler consensus. Use `LAST_WRITE_WINS` for simple feedback streams.
341341

342-
**Link to features.** Set `reference_feature_view` so the UI and documentation show which feature view the labels annotate.
342+
**Link to features.** Set `reference_feature_view` so the UI and documentation show which feature view the labels apply to.
343343

344344
**Separate noisy feedback from stable ground truth.** When possible, put expectations in dedicated fields or views with stricter writer conventions (human-only).
345345

346346
## Limitations
347347

348348
* Conflict policies are enforced on offline reads only; online store is always last-write-wins.
349349
* `LABELER_PRIORITY` requires explicit labeler ordering configuration.
350-
* Annotation profiles are UI configuration via tags — not enforced at the SDK write path.
350+
* Data labeling profiles (annotation profiles) are UI configuration via tags — not enforced at the SDK write path.
351351

352352
## Next steps
353353

354-
* [Feature view](feature-view.md) — immutable features that label views annotate
354+
* [Feature view](feature-view.md) — immutable features that label views apply labels to
355355
* [Feature retrieval](feature-retrieval.md) — point-in-time joins for training
356356
* [ADR-0012: LabelView](../../adr/ADR-0012-label-view.md) — full design rationale

docs/how-to-guides/customizing-feast/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Below are some guides on how to add new custom components:
1515
[adding-support-for-a-new-online-store.md](adding-support-for-a-new-online-store.md)
1616
{% endcontent-ref %}
1717

18-
{% content-ref url="creating-a-custom-materialization-engine.md" %}
19-
[creating-a-custom-materialization-engine.md](creating-a-custom-materialization-engine.md)
18+
{% content-ref url="creating-a-custom-compute-engine.md" %}
19+
[creating-a-custom-compute-engine.md](creating-a-custom-compute-engine.md)
2020
{% endcontent-ref %}
2121

2222
{% content-ref url="creating-a-custom-provider.md" %}

docs/reference/feature-repository/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,4 @@ To declare new feature definitions, just add code to the feature repository, eit
127127
### Next steps
128128

129129
* See [Create a feature repository](../../how-to-guides/feast-snowflake-gcp-aws/create-a-feature-repository.md) to get started with an example feature repository.
130-
* See [feature_store.yaml](feature-store-yaml.md), [.feastignore](feast-ignore.md), or [Feature Views](../../getting-started/concepts/feature-view.md) for more information on the configuration files that live in a feature registry.
130+
* See [feature_store.yaml](feature-store-yaml.md), [.feastignore](feast-ignore.md), [Registration inferencing](registration-inferencing.md), or [Feature Views](../../getting-started/concepts/feature-view.md) for more information on the configuration files that live in a feature registry.

0 commit comments

Comments
 (0)