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

Allow Python scalars in array_namespace #147

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

asmeurer
Copy link
Member

They are just ignored. This makes array_namespace easier to use for functions that accept either arrays or scalars.

I'm not sure if I should have this behavior by default, or if it should be enabled by a flag.

They are just ignored. This makes array_namespace easier to use for functions
that accept either arrays or scalars.

I'm not sure if I should have this behavior by default, or if it should be
enabled by a flag.
@asmeurer
Copy link
Member Author

We can also automatically ignore None inputs. The scipy helper does this so it would clearly be useful.

@lucascolley
Copy link
Contributor

lucascolley commented Jun 28, 2024

I would say this should be opt-in, given the standard really focusses on just arrays. In practice, it will probably be used more often than not (at least for now), but given that (for now) most projects will wrap array_namespace, it isn't a problem to have the extra argument.

In SciPy, it doesn't really matter either way as we coerce scalars to NumPy arrays before passing them to array_namespace.

@asmeurer
Copy link
Member Author

There are some active discussions on allowing scalars in more places in the array API. See data-apis/array-api#805 and data-apis/array-api#807.

but given that (for now) most projects will wrap array_namespace, it isn't a problem to have the extra argument.

I'm trying to make that not the case. Some projects like SciPy will have specific reasons they'll need to wrap things, but ideally whatever most projects need should be implemented already in the wrappers here.

@lucascolley
Copy link
Contributor

I think another form of wrapping that will be very common is using a default backend when all arguments of array_namespace are Python scalars.

@asmeurer
Copy link
Member Author

asmeurer commented Jul 1, 2024

That would be easy to add. I would caution against it though unless you are doing it for backwards compatibility. If you default to NumPy, for instance, you could end up in a situation where a user gets a NumPy array from one function because they passed in scalars, and another array from another function because they passed in arrays.

@lucascolley
Copy link
Contributor

Yeah, I'm thinking that the reason would be to maintain BC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants