Skip to content

Commit 575eded

Browse files
authored
Documentation small fixes (#591)
* Move 'Why Cubed?' out of Getting Started section * Update the Python Array Page to link to the coverage status page * Remove executor API docs as users now create executors via configuration settings (documented on the configuration page)
1 parent 03f3e0e commit 575eded

File tree

4 files changed

+2
-37
lines changed

4 files changed

+2
-37
lines changed

docs/api.rst

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,18 +83,3 @@ Runtime
8383
Spec
8484
TaskEndEvent
8585
measure_reserved_mem
86-
87-
Executors
88-
=========
89-
90-
.. currentmodule:: cubed.runtime.executors
91-
.. autosummary::
92-
:nosignatures:
93-
:toctree: generated/
94-
95-
local.SingleThreadedExecutor
96-
local.ThreadsExecutor
97-
local.ProcessesExecutor
98-
beam.BeamExecutor
99-
lithops.LithopsExecutor
100-
modal.ModalExecutor

docs/array-api.md

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,9 @@
11
# Python Array API
22

3-
Cubed implements version 2022.12 of the [Python Array API standard](https://data-apis.org/array-api/2022.12/index.html) in `cubed.array_api`, with a few exceptions noted below. Refer to its [API specification](https://data-apis.org/array-api/2022.12/API_specification/index.html) for API documentation.
4-
5-
The [linear algebra extensions](https://data-apis.org/array-api/2022.12/extensions/linear_algebra_functions.html) and [Fourier transform functions¶](https://data-apis.org/array-api/2022.12/extensions/fourier_transform_functions.html) are *not* supported.
3+
Cubed implements version 2022.12 of the [Python Array API standard](https://data-apis.org/array-api/2022.12/index.html) in `cubed.array_api`, with a few exceptions listed on the [coverage status](https://github.com/cubed-dev/cubed/blob/main/api_status.md) page. The [Fourier transform functions](https://data-apis.org/array-api/2022.12/extensions/fourier_transform_functions.html) are *not* supported.
64

75
Support for version [2023.12](https://data-apis.org/array-api/2023.12/index.html) is tracked in Cubed issue [#438](https://github.com/cubed-dev/cubed/issues/438).
86

9-
## Missing from Cubed
10-
11-
The following parts of the standard are not implemented:
12-
13-
| Category | Object/Function |
14-
| ---------------------- | ---------------- |
15-
| Array object | In-place Ops |
16-
| Creation Functions | `from_dlpack` |
17-
| Indexing | Boolean array |
18-
| Searching Functions | `nonzero` |
19-
| Set Functions | `unique_all` |
20-
| | `unique_counts` |
21-
| | `unique_inverse` |
22-
| | `unique_values` |
23-
| Sorting Functions | `argsort` |
24-
| | `sort` |
25-
| Statistical Functions | `std` |
26-
| | `var` |
27-
287
## Differences between Cubed and the standard
298

309
The following [Creation Functions](https://data-apis.org/array-api/latest/API_specification/creation_functions.html) accept extra `chunks` and `spec` keyword arguments:

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Examples <https://github.com/tomwhite/cubed/tree/main/examples/README.md>
2525
api
2626
array-api
2727
configuration
28+
why-cubed
2829
related-projects
2930
```
3031

File renamed without changes.

0 commit comments

Comments
 (0)