Skip to content

Commit 2886903

Browse files
lucascolleylucascolley
committed
Deploying to gh-pages from @ 87fe423 🚀
1 parent 56686fa commit 2886903

29 files changed

+563
-57
lines changed

‎_sources/api-lazy.md.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Tools for lazy backends
2+
3+
These additional functions are meant to be used to support compatibility with
4+
lazy backends, e.g. Dask or JAX:
5+
6+
```{eval-rst}
7+
.. currentmodule:: array_api_extra
8+
.. autosummary::
9+
:nosignatures:
10+
:toctree: generated
11+
12+
lazy_apply
13+
testing.lazy_xp_function
14+
testing.patch_lazy_xp_functions
15+
```

‎_sources/generated/array_api_extra.lazy_apply.rst.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
array\_api\_extra.lazy\_apply
2+
=============================
3+
4+
.. currentmodule:: array_api_extra
5+
6+
.. autofunction:: lazy_apply

‎_sources/index.md.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:hidden:
66
self
77
api-reference.md
8-
testing-utils.md
8+
api-lazy.md
99
contributing.md
1010
contributors.md
1111
```

‎_sources/testing-utils.md.txt‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

testing-utils.html renamed to api-lazy.html

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
6-
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="array_api_extra.testing.lazy_xp_function" href="generated/array_api_extra.testing.lazy_xp_function.html" /><link rel="prev" title="array_api_extra.sinc" href="generated/array_api_extra.sinc.html" />
6+
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="array_api_extra.lazy_apply" href="generated/array_api_extra.lazy_apply.html" /><link rel="prev" title="array_api_extra.sinc" href="generated/array_api_extra.sinc.html" />
77

88
<!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 -->
9-
<title>Testing Utilities - array-api-extra 0.7.0.dev0 documentation</title>
9+
<title>Tools for lazy backends - array-api-extra 0.7.0.dev0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
1111
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -217,7 +217,8 @@
217217
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.sinc.html">array_api_extra.sinc</a></li>
218218
</ul>
219219
</li>
220-
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Testing Utilities</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Testing Utilities</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
220+
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Tools for lazy backends</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Tools for lazy backends</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
221+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.lazy_apply.html">array_api_extra.lazy_apply</a></li>
221222
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.testing.lazy_xp_function.html">array_api_extra.testing.lazy_xp_function</a></li>
222223
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.testing.patch_lazy_xp_functions.html">array_api_extra.testing.patch_lazy_xp_functions</a></li>
223224
</ul>
@@ -244,12 +245,12 @@
244245
</a>
245246
<div class="content-icon-container">
246247
<div class="view-this-page">
247-
<a class="muted-link" href="https://github.com/data-apis/array-api-extra/blob/main/docs/testing-utils.md?plain=true" title="View this page">
248+
<a class="muted-link" href="https://github.com/data-apis/array-api-extra/blob/main/docs/api-lazy.md?plain=true" title="View this page">
248249
<svg><use href="#svg-eye"></use></svg>
249250
<span class="visually-hidden">View this page</span>
250251
</a>
251252
</div><div class="edit-this-page">
252-
<a class="muted-link" href="https://github.com/data-apis/array-api-extra/edit/main/docs/testing-utils.md" title="Edit this page">
253+
<a class="muted-link" href="https://github.com/data-apis/array-api-extra/edit/main/docs/api-lazy.md" title="Edit this page">
253254
<svg><use href="#svg-pencil"></use></svg>
254255
<span class="visually-hidden">Edit this page</span>
255256
</a>
@@ -268,18 +269,21 @@
268269
</label>
269270
</div>
270271
<article role="main" id="furo-main-content">
271-
<section id="testing-utilities">
272-
<h1>Testing Utilities<a class="headerlink" href="#testing-utilities" title="Link to this heading"></a></h1>
273-
<p>These additional functions are meant to be used while unit testing Array API
274-
compliant packages:</p>
272+
<section id="tools-for-lazy-backends">
273+
<h1>Tools for lazy backends<a class="headerlink" href="#tools-for-lazy-backends" title="Link to this heading"></a></h1>
274+
<p>These additional functions are meant to be used to support compatibility with
275+
lazy backends, e.g. Dask or JAX:</p>
275276
<div class="table-wrapper autosummary longtable docutils container">
276277
<table class="autosummary longtable docutils align-default">
277278
<tbody>
278-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.testing.lazy_xp_function.html#array_api_extra.testing.lazy_xp_function" title="array_api_extra.testing.lazy_xp_function"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lazy_xp_function</span></code></a></p></td>
279+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.lazy_apply.html#array_api_extra.lazy_apply" title="array_api_extra.lazy_apply"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lazy_apply</span></code></a></p></td>
280+
<td><p>Lazily apply an eager function.</p></td>
281+
</tr>
282+
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.testing.lazy_xp_function.html#array_api_extra.testing.lazy_xp_function" title="array_api_extra.testing.lazy_xp_function"><code class="xref py py-obj docutils literal notranslate"><span class="pre">testing.lazy_xp_function</span></code></a></p></td>
279283
<td><p>Tag a function to be tested on lazy backends.</p></td>
280284
</tr>
281-
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.testing.patch_lazy_xp_functions.html#array_api_extra.testing.patch_lazy_xp_functions" title="array_api_extra.testing.patch_lazy_xp_functions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">patch_lazy_xp_functions</span></code></a></p></td>
282-
<td><p>Test lazy execution of functions tagged with <a class="reference internal" href="generated/array_api_extra.testing.lazy_xp_function.html#array_api_extra.testing.lazy_xp_function" title="array_api_extra.testing.lazy_xp_function"><code class="xref py py-func docutils literal notranslate"><span class="pre">lazy_xp_function()</span></code></a>.</p></td>
285+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.testing.patch_lazy_xp_functions.html#array_api_extra.testing.patch_lazy_xp_functions" title="array_api_extra.testing.patch_lazy_xp_functions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">testing.patch_lazy_xp_functions</span></code></a></p></td>
286+
<td><p>Test lazy execution of functions tagged with <code class="xref py py-func docutils literal notranslate"><span class="pre">lazy_xp_function()</span></code>.</p></td>
283287
</tr>
284288
</tbody>
285289
</table>
@@ -291,12 +295,12 @@ <h1>Testing Utilities<a class="headerlink" href="#testing-utilities" title="Link
291295
<footer>
292296

293297
<div class="related-pages">
294-
<a class="next-page" href="generated/array_api_extra.testing.lazy_xp_function.html">
298+
<a class="next-page" href="generated/array_api_extra.lazy_apply.html">
295299
<div class="page-info">
296300
<div class="context">
297301
<span>Next</span>
298302
</div>
299-
<div class="title">array_api_extra.testing.lazy_xp_function</div>
303+
<div class="title">array_api_extra.lazy_apply</div>
300304
</div>
301305
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
302306
</a>

‎api-reference.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,8 @@
217217
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.sinc.html">array_api_extra.sinc</a></li>
218218
</ul>
219219
</li>
220-
<li class="toctree-l1 has-children"><a class="reference internal" href="testing-utils.html">Testing Utilities</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Testing Utilities</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
220+
<li class="toctree-l1 has-children"><a class="reference internal" href="api-lazy.html">Tools for lazy backends</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Tools for lazy backends</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
221+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.lazy_apply.html">array_api_extra.lazy_apply</a></li>
221222
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.testing.lazy_xp_function.html">array_api_extra.testing.lazy_xp_function</a></li>
222223
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.testing.patch_lazy_xp_functions.html">array_api_extra.testing.patch_lazy_xp_functions</a></li>
223224
</ul>

‎contributing.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,8 @@
217217
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.sinc.html">array_api_extra.sinc</a></li>
218218
</ul>
219219
</li>
220-
<li class="toctree-l1 has-children"><a class="reference internal" href="testing-utils.html">Testing Utilities</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Testing Utilities</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
220+
<li class="toctree-l1 has-children"><a class="reference internal" href="api-lazy.html">Tools for lazy backends</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Tools for lazy backends</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
221+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.lazy_apply.html">array_api_extra.lazy_apply</a></li>
221222
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.testing.lazy_xp_function.html">array_api_extra.testing.lazy_xp_function</a></li>
222223
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.testing.patch_lazy_xp_functions.html">array_api_extra.testing.patch_lazy_xp_functions</a></li>
223224
</ul>

‎contributors.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,8 @@
217217
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.sinc.html">array_api_extra.sinc</a></li>
218218
</ul>
219219
</li>
220-
<li class="toctree-l1 has-children"><a class="reference internal" href="testing-utils.html">Testing Utilities</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Testing Utilities</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
220+
<li class="toctree-l1 has-children"><a class="reference internal" href="api-lazy.html">Tools for lazy backends</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Tools for lazy backends</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
221+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.lazy_apply.html">array_api_extra.lazy_apply</a></li>
221222
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.testing.lazy_xp_function.html">array_api_extra.testing.lazy_xp_function</a></li>
222223
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.testing.patch_lazy_xp_functions.html">array_api_extra.testing.patch_lazy_xp_functions</a></li>
223224
</ul>

‎generated/array_api_extra.apply_where.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,8 @@
217217
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.sinc.html">array_api_extra.sinc</a></li>
218218
</ul>
219219
</li>
220-
<li class="toctree-l1 has-children"><a class="reference internal" href="../testing-utils.html">Testing Utilities</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Testing Utilities</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
220+
<li class="toctree-l1 has-children"><a class="reference internal" href="../api-lazy.html">Tools for lazy backends</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Tools for lazy backends</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
221+
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.lazy_apply.html">array_api_extra.lazy_apply</a></li>
221222
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.testing.lazy_xp_function.html">array_api_extra.testing.lazy_xp_function</a></li>
222223
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.testing.patch_lazy_xp_functions.html">array_api_extra.testing.patch_lazy_xp_functions</a></li>
223224
</ul>

‎generated/array_api_extra.at.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,8 @@
217217
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.sinc.html">array_api_extra.sinc</a></li>
218218
</ul>
219219
</li>
220-
<li class="toctree-l1 has-children"><a class="reference internal" href="../testing-utils.html">Testing Utilities</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Testing Utilities</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
220+
<li class="toctree-l1 has-children"><a class="reference internal" href="../api-lazy.html">Tools for lazy backends</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Tools for lazy backends</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
221+
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.lazy_apply.html">array_api_extra.lazy_apply</a></li>
221222
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.testing.lazy_xp_function.html">array_api_extra.testing.lazy_xp_function</a></li>
222223
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.testing.patch_lazy_xp_functions.html">array_api_extra.testing.patch_lazy_xp_functions</a></li>
223224
</ul>

0 commit comments

Comments
 (0)