-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
fix(python): improve support for user-defined functions that return scalars #16556
Merged
ritchie46
merged 13 commits into
pola-rs:main
from
itamarst:14748-consistent-gufunc-behavior
May 30, 2024
Merged
fix(python): improve support for user-defined functions that return scalars #16556
ritchie46
merged 13 commits into
pola-rs:main
from
itamarst:14748-consistent-gufunc-behavior
May 30, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
enhancement
New feature or an improvement of an existing feature
python
Related to Python Polars
labels
May 28, 2024
itamarst
changed the title
feat(python): in map_batches() with a user-defined functions that return scalars, allow keeping results as scalars
fix(python): improve support for user-defined functions that return scalars
May 28, 2024
itamarst
requested review from
ritchie46,
stinodego,
c-peters,
alexander-beedie,
MarcoGorelli,
reswqa and
orlp
as code owners
May 28, 2024 17:16
ritchie46
approved these changes
May 30, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good @itamarst. Thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
enhancement
New feature or an improvement of an existing feature
fix
Bug fix
python
Related to Python Polars
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #14748
First, using generalized ufuncs that returned scalars didn't work with the latest version of Polars, at least. Consider the following script:
On the released version of Polars it fails with:
This is fixed in this branch (see the new test in
test_ufunc_expr.py
).Second, if your user-defined function returns a scalar, chances are you want to keep it as a scalar. Unfortunately
map_batches()
had no way to express this previously, so the scalar would be wrapped in a list, making it annoying to use.This is analogous to the equivalent flag in
pl.map_groups()
: https://docs.pola.rs/py-polars/html/reference/expressions/api/polars.map_groups.html (unfortunately with the opposite default, for backwards compatibility reasons).Here's what it look like in the new branch: