Skip to content

Allow __dlpack__ to work with newer versions of NumPy #86

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

Merged
merged 4 commits into from
Nov 8, 2024
Merged

Allow __dlpack__ to work with newer versions of NumPy #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c80f6d
Allow __dlpack__ to work with newer versions of NumPy
asmeurer Nov 7, 2024
fa71e9e
Fix version check
asmeurer Nov 7, 2024
67d9667
Remove unused import
asmeurer Nov 7, 2024
93201f1
Fix passing of keyword arguments in __dlpack__ for NumPy 2.1
asmeurer Nov 7, 2024
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
27 changes: 18 additions & 9 deletions array_api_strict/_array_object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

if TYPE_CHECKING:
from typing import Optional, Tuple, Union, Any
from ._typing import PyCapsule, Device, Dtype
from ._typing import PyCapsule, Dtype
import numpy.typing as npt

import numpy as np
Expand Down Expand Up @@ -586,15 +586,24 @@ def __dlpack__(
if copy is not _default:
raise ValueError("The copy argument to __dlpack__ requires at least version 2023.12 of the array API")

# Going to wait for upstream numpy support
if max_version not in [_default, None]:
raise NotImplementedError("The max_version argument to __dlpack__ is not yet implemented")
if dl_device not in [_default, None]:
raise NotImplementedError("The device argument to __dlpack__ is not yet implemented")
if copy not in [_default, None]:
raise NotImplementedError("The copy argument to __dlpack__ is not yet implemented")
if np.__version__[0] < '2.1':
Copy link

Choose a reason for hiding this comment

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

This is incorrect:

>>> np.__version__
'2.1.3'
>>> np.__version__[0] < '2.1'
True

numpy.lib.NumpyVersion can be used here

if max_version not in [_default, None]:
raise NotImplementedError("The max_version argument to __dlpack__ is not yet implemented")
if dl_device not in [_default, None]:
raise NotImplementedError("The device argument to __dlpack__ is not yet implemented")
if copy not in [_default, None]:
raise NotImplementedError("The copy argument to __dlpack__ is not yet implemented")

return self._array.__dlpack__(stream=stream)
return self._array.__dlpack__(stream=stream)
else:
kwargs = {'stream': stream}
if max_version is not _default:
kwargs['max_version'] = max_version
if dl_device is not _default:
kwargs['dl_device'] = dl_device
if copy is not _default:
kwargs['copy'] = copy
return self._array.__dlpack__(**kwargs)

def __dlpack_device__(self: Array, /) -> Tuple[IntEnum, int]:
"""
Expand Down
39 changes: 24 additions & 15 deletions array_api_strict/tests/test_array_object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,18 +460,27 @@ def dlpack_2023_12(api_version):
a.__dlpack__()


exception = NotImplementedError if api_version >= '2023.12' else ValueError
pytest.raises(exception, lambda:
a.__dlpack__(dl_device=CPU_DEVICE))
pytest.raises(exception, lambda:
a.__dlpack__(dl_device=None))
pytest.raises(exception, lambda:
a.__dlpack__(max_version=(1, 0)))
pytest.raises(exception, lambda:
a.__dlpack__(max_version=None))
pytest.raises(exception, lambda:
a.__dlpack__(copy=False))
pytest.raises(exception, lambda:
a.__dlpack__(copy=True))
pytest.raises(exception, lambda:
a.__dlpack__(copy=None))
if np.__version__ < '2.1':
exception = NotImplementedError if api_version >= '2023.12' else ValueError
pytest.raises(exception, lambda:
a.__dlpack__(dl_device=CPU_DEVICE))
pytest.raises(exception, lambda:
a.__dlpack__(dl_device=None))
pytest.raises(exception, lambda:
a.__dlpack__(max_version=(1, 0)))
pytest.raises(exception, lambda:
a.__dlpack__(max_version=None))
pytest.raises(exception, lambda:
a.__dlpack__(copy=False))
pytest.raises(exception, lambda:
a.__dlpack__(copy=True))
pytest.raises(exception, lambda:
a.__dlpack__(copy=None))
else:
a.__dlpack__(dl_device=CPU_DEVICE)
a.__dlpack__(dl_device=None)
a.__dlpack__(max_version=(1, 0))
a.__dlpack__(max_version=None)
a.__dlpack__(copy=False)
a.__dlpack__(copy=True)
a.__dlpack__(copy=None)
Loading