Skip to content

Commit 00e9185

Browse files
committed
Some small updates to the docs
1 parent 00d7ac5 commit 00e9185

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docs/index.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -145,11 +145,12 @@ issue, but this hasn't necessarily been tested thoroughly.
145145
the [xfails
146146
file](https://github.com/data-apis/array-api-strict/blob/main/array-api-tests-xfails.txt).
147147

148-
The most notable of these is that in NumPy 1.26, the `copy=False` flag is
149-
not implemented for `asarray` and therefore `array_api_strict` raises
150-
`NotImplementedError` in that case.
148+
2. array-api-strict is just a thin, pure Python wrapper around `numpy.ndarray`
149+
and `numpy` functions. As such, the performance should be mostly comparable
150+
to NumPy, but nonetheless, performance is not a primary concern for this
151+
library, since it is only intended to be used for testing purposes.
151152

152-
2. Since NumPy is a CPU-only library, the [device
153+
3. Since NumPy is a CPU-only library, the [device
153154
support](https://data-apis.org/array-api/latest/design_topics/device_support.html)
154155
in array-api-strict is superficial only. `x.device` is always a (private)
155156
`CPU_DEVICE` object, and `device` keywords to creation functions only
@@ -158,15 +159,15 @@ issue, but this hasn't necessarily been tested thoroughly.
158159
backend](https://github.com/data-apis/array-api-strict/issues/5) so that
159160
more significant device support can be tested.
160161

161-
3. Although only array types are expected in array-api-strict functions,
162+
4. Although only array types are expected in array-api-strict functions,
162163
currently most functions do not do extensive type checking on their inputs,
163164
so a sufficiently duck-typed object may pass through silently (or at best,
164165
you may get `AttributeError` instead of `TypeError`). However, all type
165166
signatures have type annotations (based on those from the standard), so
166167
this deviation may be tested with type checking. This [behavior may improve
167168
in the future](https://github.com/data-apis/array-api-strict/issues/6).
168169

169-
4. There are some behaviors in the standard that are not required to be
170+
5. There are some behaviors in the standard that are not required to be
170171
implemented by libraries that cannot support [data dependent
171172
shapes](https://data-apis.org/array-api/latest/design_topics/data_dependent_output_shapes.html).
172173
This includes [the `unique_*`
@@ -178,9 +179,9 @@ issue, but this hasn't necessarily been tested thoroughly.
178179
function. array-api-strict currently implements all of these. In the
179180
future, [there may be a way to disable them](https://github.com/data-apis/array-api-strict/issues/7).
180181

181-
5. array-api-strict currently only supports the latest version of the array
182-
API standard. [This may change in the future depending on
183-
need](https://github.com/data-apis/array-api-strict/issues/8).
182+
6. array-api-strict currently only supports the 2022.12 version of the array
183+
API standard. [Support for 2023.12 is
184+
planned](https://github.com/data-apis/array-api-strict/issues/25).
184185

185186
## Usage
186187

@@ -192,8 +193,8 @@ Previously this implementation was available as `numpy.array_api`, but it was
192193
moved to a separate package for NumPy 2.0.
193194

194195
Note that the history of this repo prior to commit
195-
fbefd42e4d11e9be20e0a4785f2619fc1aef1e7c was generated automatically
196-
from the numpy git history, using the following
196+
[fbefd42e4d11e9be20e0a4785f2619fc1aef1e7c](https://github.com/data-apis/array-api-strict/commit/fbefd42e4d11e9be20e0a4785f2619fc1aef1e7c)
197+
was generated automatically from the numpy git history, using the following
197198
[git-filter-repo](https://github.com/newren/git-filter-repo) command:
198199

199200
```

0 commit comments

Comments
 (0)