Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Adding name to documentation
Signed-off-by: Nick Quinn <nicholas_quinn@apple.com>
  • Loading branch information
nickquinn408 committed Mar 9, 2026
commit 0bfaeaa57f3013f12e003c7d64db2d6d6a91cf2d
3 changes: 2 additions & 1 deletion docs/getting-started/concepts/batch-feature-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ driver_fv = BatchFeatureView(
Field(name="conv_rate", dtype=Float32),
],
aggregations=[
Aggregation(column="conv_rate", function="sum", time_window=timedelta(days=1)),
Aggregation(column="conv_rate", function="sum", time_window=timedelta(days=1), name="total_conv_rate_1d"),
],
source=source,
)
Expand Down Expand Up @@ -144,6 +144,7 @@ See:
- `sink_source` is **required** when chaining views (i.e., `source` is another FeatureView or list of them).
- Schema fields must be consistent with `sink_source`, `batch_source.field_mapping` if field mappings exist.
- Aggregation logic must reference columns present in the raw source or transformed inputs.
- The output feature name for an aggregation defaults to `{function}_{column}` (e.g., `sum_conv_rate`). Use the `name` parameter to override it (e.g., `name="total_conv_rate_1d"`).

---

Expand Down
13 changes: 9 additions & 4 deletions docs/getting-started/concepts/tiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,9 @@ customer_features = StreamFeatureView(
batch_source=file_source, # For historical data
),
aggregations=[
Aggregation(column="amount", function="sum", time_window=timedelta(hours=1)),
Aggregation(column="amount", function="avg", time_window=timedelta(hours=1)),
Aggregation(column="amount", function="std", time_window=timedelta(hours=1)),
Aggregation(column="amount", function="sum", time_window=timedelta(hours=1), name="sum_amount_1h"),
Aggregation(column="amount", function="avg", time_window=timedelta(hours=1), name="avg_amount_1h"),
Aggregation(column="amount", function="std", time_window=timedelta(hours=1), name="std_amount_1h"),
],
timestamp_field="event_timestamp",
online=True,
Expand All @@ -229,7 +229,12 @@ customer_features = StreamFeatureView(

### Key Parameters

- `aggregations`: List of time-windowed aggregations to compute
- `aggregations`: List of time-windowed aggregations to compute. Each `Aggregation` accepts:
- `column`: source column to aggregate
- `function`: aggregation function (`sum`, `avg`, `mean`, `min`, `max`, `count`, `std`)
- `time_window`: duration of the aggregation window
- `slide_interval`: hop/slide size (defaults to `time_window`)
- `name` *(optional)*: output feature name. Defaults to `{function}_{column}` (e.g., `sum_amount`). Set this to use a custom name (e.g., `name="sum_amount_1h"`).
- `timestamp_field`: Column name for timestamps (required when aggregations are specified)
- `enable_tiling`: Enable tiling optimization (default: `False`)
- Set to `True` for **streaming scenarios**
Expand Down
Loading