Skip to content

Add helper for getting array namespace from an array #1085

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.

Sign up for GitHub

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

Closed
msimberg wants to merge 2 commits into from
Closed

Add helper for getting array namespace from an array #1085

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2180246
Add helper for getting array namespace from an array
msimberg Mar 2, 2026
e3b4a49
Merge remote-tracking branch 'origin/main' into array-ns-from-array
msimberg Mar 2, 2026
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
16 changes: 16 additions & 0 deletions model/common/src/icon4py/model/common/utils/data_allocation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,22 @@ def array_ns(try_cupy: bool) -> ModuleType:
return np


def array_ns_from_array(array: NDArray) -> ModuleType:
Copy link
Contributor

@jcanton jcanton Mar 3, 2026

Choose a reason for hiding this comment

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

Suggested change
def array_ns_from_array(array: NDArray) -> ModuleType:
def get_array_ns_from_array(array: NDArray) -> ModuleType:

to keep in line with (Magda's?) get/compute/apply

Copy link
Contributor Author

@msimberg msimberg Mar 3, 2026

Choose a reason for hiding this comment

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

I must say I don't love adding get etc. everywhere, but I don't object. If you prefer adding it let's do it.

Copy link
Contributor

@havogt havogt Mar 3, 2026

Choose a reason for hiding this comment

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

In gt4py we recently introduced array_api_compat as a dependency which provides array_api_compat.array_namespace(array)

Copy link
Contributor

@havogt havogt Mar 3, 2026

Choose a reason for hiding this comment

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

https://data-apis.org/array-api-compat

"""
Returns the array namespace for a given array.
"""
if hasattr(array, "__array_namespace__"):
return array.__array_namespace__()
elif isinstance(array, np.ndarray):
return np
elif isinstance(array, xp.ndarray):
return xp
else:
raise RuntimeError(
f"Unsupported array type '{type(array)}'. Cannot detect the array namespace."
)


def import_array_ns(allocator: gtx_typing.Allocator | None) -> ModuleType:
"""Import cupy or numpy depending on a chosen GT4Py backend DevicType."""
return array_ns(device_utils.is_cupy_device(allocator))
Expand Down