Skip to content

Commit ed5705f

Browse files
committed
Rename numpy_array_api_compat/ to array_api_compat/
1 parent 076848e commit ed5705f

File tree

14 files changed

+16
-2
lines changed

14 files changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# NumPy Array API compatibility library
1+
# Array API compatibility library
22

33
This is a small wrapper around NumPy that is compatible with the [Array API
44
standard](https://data-apis.org/array-api/latest/). See also [NEP 47](https://numpy.org/neps/nep-0047-array-api-standard.html).
@@ -13,6 +13,8 @@ separate Array object, but rather just uses `numpy.ndarray` directly.
1313
Note that some of the functionality in this library is backwards incompatible
1414
with NumPy.
1515

16+
This library also supports CuPy in addition to NumPy.
17+
1618
Library authors using the Array API may wish to test against `numpy.array_api`
1719
to ensure they are not using functionality outside of the standard, but prefer
1820
this implementation for end users who use NumPy arrays.
@@ -28,5 +30,17 @@ import numpy as np
2830
with
2931

3032
```py
31-
import numpy_array_api_compat as np
33+
import array_api_compat.numpy as np
34+
```
35+
36+
and replace
37+
38+
```py
39+
import cupy as cp
40+
```
41+
42+
with
43+
44+
```py
45+
import array_api_compat.cupy as cp
3246
```
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)