deploy: 575eded

_sources/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

_sources/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:

_sources/index.md

@@ -25,6 +25,7 @@ Examples <https://github.com/tomwhite/cubed/tree/main/examples/README.md>
 api
 array-api
 configuration
+why-cubed
 related-projects
 ```
 

_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '03f3e0e',
+    VERSION: '575eded',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

api.html

@@ -36,7 +36,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=10ebb3cd"></script>
+    <script src="_static/documentation_options.js?v=cccd218b"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -151,7 +151,6 @@
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">For users</span></p>
 <ul class="current nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="getting-started/index.html">Getting Started</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
-<li class="toctree-l2"><a class="reference internal" href="getting-started/why-cubed.html">Why Cubed?</a></li>
 <li class="toctree-l2"><a class="reference internal" href="getting-started/installation.html">Installation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="getting-started/demo.html">Demo</a></li>
 </ul>
@@ -189,16 +188,11 @@
 <li class="toctree-l2"><a class="reference internal" href="generated/cubed.Spec.html">cubed.Spec</a></li>
 <li class="toctree-l2"><a class="reference internal" href="generated/cubed.TaskEndEvent.html">cubed.TaskEndEvent</a></li>
 <li class="toctree-l2"><a class="reference internal" href="generated/cubed.measure_reserved_mem.html">cubed.measure_reserved_mem</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/cubed.runtime.executors.local.SingleThreadedExecutor.html">cubed.runtime.executors.local.SingleThreadedExecutor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/cubed.runtime.executors.local.ThreadsExecutor.html">cubed.runtime.executors.local.ThreadsExecutor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/cubed.runtime.executors.local.ProcessesExecutor.html">cubed.runtime.executors.local.ProcessesExecutor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/cubed.runtime.executors.beam.BeamExecutor.html">cubed.runtime.executors.beam.BeamExecutor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/cubed.runtime.executors.lithops.LithopsExecutor.html">cubed.runtime.executors.lithops.LithopsExecutor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/cubed.runtime.executors.modal.ModalExecutor.html">cubed.runtime.executors.modal.ModalExecutor</a></li>
 </ul>
 </details></li>
 <li class="toctree-l1"><a class="reference internal" href="array-api.html">Python Array API</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="why-cubed.html">Why Cubed?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="related-projects.html">Related Projects</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">For developers</span></p>
@@ -361,7 +355,6 @@ <h2> Contents </h2>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#non-standardised-functions">Non-standardised functions</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#random-number-generation">Random number generation</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#runtime">Runtime</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#executors">Executors</a></li>
 </ul>
             </nav>
         </div>
@@ -489,32 +482,6 @@ <h2>Runtime<a class="headerlink" href="#runtime" title="Link to this heading">#<
 </table>
 </div>
 </section>
-<section id="executors">
-<h2>Executors<a class="headerlink" href="#executors" title="Link to this heading">#</a></h2>
-<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
-<tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/cubed.runtime.executors.local.SingleThreadedExecutor.html#cubed.runtime.executors.local.SingleThreadedExecutor" title="cubed.runtime.executors.local.SingleThreadedExecutor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">local.SingleThreadedExecutor</span></code></a></p></td>
-<td><p>The default execution engine that runs tasks sequentially uses Python loops.</p></td>
-</tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/cubed.runtime.executors.local.ThreadsExecutor.html#cubed.runtime.executors.local.ThreadsExecutor" title="cubed.runtime.executors.local.ThreadsExecutor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">local.ThreadsExecutor</span></code></a></p></td>
-<td><p>An execution engine that uses Python asyncio.</p></td>
-</tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/cubed.runtime.executors.local.ProcessesExecutor.html#cubed.runtime.executors.local.ProcessesExecutor" title="cubed.runtime.executors.local.ProcessesExecutor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">local.ProcessesExecutor</span></code></a></p></td>
-<td><p>An execution engine that uses local processes.</p></td>
-</tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/cubed.runtime.executors.beam.BeamExecutor.html#cubed.runtime.executors.beam.BeamExecutor" title="cubed.runtime.executors.beam.BeamExecutor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">beam.BeamExecutor</span></code></a></p></td>
-<td><p>An execution engine that uses Apache Beam.</p></td>
-</tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/cubed.runtime.executors.lithops.LithopsExecutor.html#cubed.runtime.executors.lithops.LithopsExecutor" title="cubed.runtime.executors.lithops.LithopsExecutor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lithops.LithopsExecutor</span></code></a></p></td>
-<td><p>An execution engine that uses Lithops.</p></td>
-</tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/cubed.runtime.executors.modal.ModalExecutor.html#cubed.runtime.executors.modal.ModalExecutor" title="cubed.runtime.executors.modal.ModalExecutor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modal.ModalExecutor</span></code></a></p></td>
-<td><p>An execution engine that uses Modal's async API.</p></td>
-</tr>
-</tbody>
-</table>
-</div>
-</section>
 </section>
 
 
@@ -568,7 +535,6 @@ <h2>Executors<a class="headerlink" href="#executors" title="Link to this heading
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#non-standardised-functions">Non-standardised functions</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#random-number-generation">Random number generation</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#runtime">Runtime</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#executors">Executors</a></li>
 </ul>
   </nav></div>