From 575eded3ca01a980887489e8243f2bad8a703b84 Mon Sep 17 00:00:00 2001 From: Tom White Date: Tue, 1 Oct 2024 16:21:23 +0100 Subject: [PATCH] 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) --- docs/api.rst | 15 --------------- docs/array-api.md | 23 +---------------------- docs/index.md | 1 + docs/{getting-started => }/why-cubed.md | 0 4 files changed, 2 insertions(+), 37 deletions(-) rename docs/{getting-started => }/why-cubed.md (100%) diff --git a/docs/api.rst b/docs/api.rst index 3d1d52c2..c2bf32b9 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -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 diff --git a/docs/array-api.md b/docs/array-api.md index 9b0d5d40..b4021771 100644 --- a/docs/array-api.md +++ b/docs/array-api.md @@ -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: diff --git a/docs/index.md b/docs/index.md index c0549333..e6514426 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,6 +25,7 @@ Examples api array-api configuration +why-cubed related-projects ``` diff --git a/docs/getting-started/why-cubed.md b/docs/why-cubed.md similarity index 100% rename from docs/getting-started/why-cubed.md rename to docs/why-cubed.md