Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use .element() instead of .data() for window range calculations #13095

Merged

Conversation

mythrocks
Copy link
Contributor

Summary

This change is in preparation for supporting STRING order-by columns in range window functions. It updates how order-by column values are accessed for range-based window functions. No user-facing APIs are altered.

Description

In the staging step for executing window range queries, the boundaries of each row's window are calculated. This involves subtracting/adding the preceding/following values from each order-by column row, and then searching backwards/forwards for the boundary values.

The staging step has been using column_device_view.data() for accessing the order-by rows, an acceptable approach for when the order-by columns are numeric (e.g. INT32).

This approach fails when the order-by column is a STRING, because .data() is not defined for such columns. A better approach would be to use .element() to directly access the rows, because it has special handling for STRING, among other types, while continuing to work for numeric primitives.

Future

In a followup to this change, support for STRING order-by columns will be added.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

…nge calculations.

This change is in preparation for supporting `STRING` order-by columns in range window functions.

In the staging step for executing window range queries, the boundaries of each row's window are
calculated. This involves subtracting/adding the `preceding`/`following` values from each
order-by column row, and then searching backwards/forwards for the boundary values.

The staging step has been using `column_device_view.data()` for accessing the order-by rows,
an acceptable approach for when the order-by columns are numeric (e.g. `INT32`).

This approach fails when the order-by column is a `STRING`, because `.data()` is not defined
for such columns. A better approach would be to use `.element()` to directly access the rows,
because it has special handling for `STRING`, among other types, while continuing to work
for numeric primitives.

In a followup to this change, support for `STRING` order-by columns will be added.

Signed-off-by: MithunR <mythrocks@gmail.com>
@mythrocks mythrocks added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Apr 7, 2023
@mythrocks mythrocks self-assigned this Apr 7, 2023
@mythrocks mythrocks requested a review from a team as a code owner April 7, 2023 22:30
@github-actions github-actions bot added the libcudf Affects libcudf (C++/CUDA) code. label Apr 7, 2023
1. Naming conventions for function/method parameter.
2. More const for identifiers, where applicable.
@mythrocks
Copy link
Contributor Author

Rerun tests

@vyasr
Copy link
Contributor

vyasr commented Apr 12, 2023

@mythrocks the world has changed since our GHA migration :) See https://docs.rapids.ai/resources/github-actions/#rerunning-failed-github-actions for how to rerun tests

Copy link
Member

@PointKernel PointKernel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mythrocks
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 5c93b44 into rapidsai:branch-23.06 Apr 14, 2023
@mythrocks
Copy link
Contributor Author

Thank you for the reviews, @ttnghia, @PointKernel. I have merged this change.

rapids-bot bot pushed a commit that referenced this pull request Apr 21, 2023
This commit adds support to use `STRING` columns as the order-by column in range-based window functions.

## Context
A range-based window function allows a variable-width window to be defined around each row of an input column. The "range" describes the range of values in an order-by column.

Consider the following input:

```c++
agg_column = {  1,   1,   1,   1,   1,   1,   1 };   // The aggregation column.
oby_column = { "0", "1", "2", "3", "4", "5", "6" };  // The order-by column.
//                        ^
```
If the range is defined as `[preceding=∞, following=0]`, then for the row at index `2`, the window would be rows `0-2`.

The supported range bounds for `STRING` order-by column are:
1. `UNBOUNDED` (i.e. extending to the beginning/end of the column/group) 
2. `CURRENT ROW`, indicating that all equivalent values of the current row in the `oby_column`.

Since `STRING` columns cannot have "delta" values, only `UNBOUNDED` and `CURRENT ROW` based window bounds are supported, unlike for numeric types which could specify a specific scalar delta value as a range.

Depends on #13095.

Authors:
  - MithunR (https://github.com/mythrocks)
  - Nghia Truong (https://github.com/ttnghia)

Approvers:
  - David Wendt (https://github.com/davidwendt)
  - Nghia Truong (https://github.com/ttnghia)

URL: #13143
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improvement / enhancement to an existing function libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants