Skip to content

Commit a1bb958

Browse files
committed
Add notes about minumum supported versions in the README
1 parent 5eba5fe commit a1bb958

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,11 +141,29 @@ specification:
141141
50](https://numpy.org/neps/nep-0050-scalar-promotion.html) and
142142
https://github.com/numpy/numpy/issues/22341)
143143

144+
- `asarray()` does not support `copy=False`.
145+
144146
- Functions which are not wrapped may not have the same type annotations
145147
as the spec.
146148

147149
- Functions which are not wrapped may not use positional-only arguments.
148150

151+
The minimum supported NumPy version is 1.21. However, this older version of
152+
NumPy has a few issues:
153+
154+
- `unique_*` will not compare nans as unequal.
155+
- `finfo()` has no `smallest_normal`.
156+
- No `from_dlpack` or `__dlpack__`.
157+
- `argmax()` and `argmin()` do not have `keepdims`.
158+
- `qr()` doesn't support matrix stacks.
159+
- `asarray()` doesn't support `copy=True` (as noted above, `copy=False` is not
160+
supported even in the latest NumPy).
161+
- Type promotion behavior will be value based for 0-D arrays (and there is no
162+
`NPY_PROMOTION_STATE=weak` to disable this).
163+
164+
If any of these are an issue, it is recommended to bump your minimum NumPy
165+
version.
166+
149167
### PyTorch
150168

151169
- Like NumPy/CuPy, we do not wrap the `torch.Tensor` object. It is missing the
@@ -190,6 +208,8 @@ specification:
190208
- As with NumPy, type annotations and positional-only arguments may not
191209
exactly match the spec for functions that are not wrapped at all.
192210

211+
The minimum supported PyTorch version is 1.13.
212+
193213
## Vendoring
194214

195215
This library supports vendoring as an installation method. To vendor the

0 commit comments

Comments
 (0)