@@ -71,23 +71,24 @@ namespace, except that functions that are part of the array API are wrapped so
71
71
that they have the correct array API behavior. In each case, the array object
72
72
used will be the same array object from the wrapped library.
73
73
74
- ## Difference between ` array_api_compat ` and ` numpy.array_api `
74
+ ## Difference between ` array_api_compat ` and ` array_api_strict `
75
75
76
- ` numpy.array_api ` is a strict minimal implementation of the Array API (see
76
+ ` array_api_strict ` is a strict minimal implementation of the array API standard, formerly
77
+ known as ` numpy.array_api ` (see
77
78
[ NEP 47] ( https://numpy.org/neps/nep-0047-array-api-standard.html ) ). For
78
- example, ` numpy.array_api ` does not include any functions that are not part of
79
+ example, ` array_api_strict ` does not include any functions that are not part of
79
80
the array API specification, and will explicitly disallow behaviors that are
80
81
not required by the spec (e.g., [ cross-kind type
81
82
promotions] ( https://data-apis.org/array-api/latest/API_specification/type_promotion.html ) ).
82
- (` cupy.array_api ` is similar to ` numpy.array_api ` )
83
+ (` cupy.array_api ` is similar to ` array_api_strict ` )
83
84
84
85
` array_api_compat ` , on the other hand, is just an extension of the
85
86
corresponding array library namespaces with changes needed to be compliant
86
87
with the array API. It includes all additional library functions not mentioned
87
88
in the spec, and allows any library behaviors not explicitly disallowed by it,
88
89
such as cross-kind casting.
89
90
90
- In particular, unlike ` numpy.array_api ` , this package does not use a separate
91
+ In particular, unlike ` array_api_strict ` , this package does not use a separate
91
92
` Array ` object, but rather just uses the corresponding array library array
92
93
objects (` numpy.ndarray ` , ` cupy.ndarray ` , ` torch.Tensor ` , etc.) directly. This
93
94
is because those are the objects that are going to be passed as inputs to
@@ -96,7 +97,7 @@ functions by end users. This does mean that a few behaviors cannot be wrapped
96
97
most things.
97
98
98
99
Array consuming library authors coding against the array API may wish to test
99
- against ` numpy.array_api ` to ensure they are not using functionality outside
100
+ against ` array_api_strict ` to ensure they are not using functionality outside
100
101
of the standard, but prefer this implementation for the default behavior for
101
102
end-users.
102
103
0 commit comments