Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation small fixes #591

Merged
merged 3 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,18 +83,3 @@ Runtime
Spec
TaskEndEvent
measure_reserved_mem

Executors
=========

.. currentmodule:: cubed.runtime.executors
.. autosummary::
:nosignatures:
:toctree: generated/

local.SingleThreadedExecutor
local.ThreadsExecutor
local.ProcessesExecutor
beam.BeamExecutor
lithops.LithopsExecutor
modal.ModalExecutor
23 changes: 1 addition & 22 deletions docs/array-api.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,9 @@
# Python Array API

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.

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.
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.

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).

## Missing from Cubed

The following parts of the standard are not implemented:

| Category | Object/Function |
| ---------------------- | ---------------- |
| Array object | In-place Ops |
| Creation Functions | `from_dlpack` |
| Indexing | Boolean array |
| Searching Functions | `nonzero` |
| Set Functions | `unique_all` |
| | `unique_counts` |
| | `unique_inverse` |
| | `unique_values` |
| Sorting Functions | `argsort` |
| | `sort` |
| Statistical Functions | `std` |
| | `var` |

## Differences between Cubed and the standard

The following [Creation Functions](https://data-apis.org/array-api/latest/API_specification/creation_functions.html) accept extra `chunks` and `spec` keyword arguments:
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Examples <https://github.com/tomwhite/cubed/tree/main/examples/README.md>
api
array-api
configuration
why-cubed
related-projects
```

Expand Down
File renamed without changes.
Loading