Deploying to gh-pages from @ eced421 🚀

Author: asmeurer

_sources/api.rst.txt

@@ -3,6 +3,8 @@ API Reference
 
 .. automodule:: array_api_strict
 
+.. _array-api-strict-flags:
+
 Array API Strict Flags
 ----------------------
 
@@ -11,6 +13,7 @@ Array API Strict Flags
 .. currentmodule:: array_api_strict
 
 .. autofunction:: get_array_api_strict_flags
+
 .. autofunction:: set_array_api_strict_flags
 .. autofunction:: reset_array_api_strict_flags
 .. autoclass:: ArrayAPIStrictFlags

_sources/changelog.md.txt

@@ -1,5 +1,34 @@
 # Changelog
 
+## 2.0 (2024-06-27)
+
+### Major Changes
+
+- array-api-strict has a new set of [flags](array-api-strict-flags) that can
+  be used to dynamically enable or disable features in array-api-strict. These
+  flags allow you to change the supported array API version, enable or disable
+  [extensions](https://data-apis.org/array-api/latest/extensions/index.html),
+  enable or disable features that rely on data-dependent shapes, and enable or
+  disable boolean indexing. Future versions may add additional flags to allow
+  changing other optional or varying behaviors in the standard.
+
+- Added experimental support for the
+  [2023.12](https://data-apis.org/array-api/2023.12/changelog.html#v2023-12)
+  version of the array API standard. The default version is still 2022.12, but
+  the version can be changed to 2023.12 using the aforementioned flags, either
+  by calling
+  {func}`array_api_strict.set_array_api_strict_flags(api_version='2023.12')
+  <array_api_strict.set_array_api_strict_flags>` or setting the environment
+  variable {envvar}`ARRAY_API_STRICT_API_VERSION=2023.12
+  <ARRAY_API_STRICT_API_VERSION>`. A future version of array-api-strict will
+  change the default version to 2023.12.
+
+### Minor Changes
+
+- Calling `iter()` on an array now correctly raises `TypeError`.
+
+- Add some missing names to `__all__`.
+
 ## 1.1.1 (2024-04-29)
 
 - Fix the `api_version` argument to `__array_namespace__` to accept

_sources/index.md.txt

@@ -15,9 +15,12 @@ libraries. Consuming library code should use the
 support the array API. Rather, it is intended to be used in the test suites of
 consuming libraries to test their array API usage.
 
-array-api-strict currently supports the 2022.12 version of the standard.
-2023.12 support is planned and is tracked by [this
-issue](https://github.com/data-apis/array-api-strict/issues/25).
+array-api-strict currently supports the
+[2022.12](https://data-apis.org/array-api/latest/changelog.html#v2022-12)
+version of the standard. Experimental
+[2023.12](https://data-apis.org/array-api/latest/changelog.html#v2023-12)
+support is implemented, [but must be enabled with a
+flag](array-api-strict-flags).
 
 ## Install
 
@@ -34,7 +37,7 @@ and [Conda-forge](https://anaconda.org/conda-forge/array-api-strict)
 conda install --channel conda-forge array-api-strict
 ```
 
-array-api-strict supports NumPy 1.26 and (the upcoming) NumPy 2.0.
+array-api-strict supports NumPy 1.26 and NumPy 2.0.
 
 ## Rationale
 
@@ -106,7 +109,7 @@ strict/minimal:
   like `sin` will accept integer array inputs, but the [standard only requires
   them to accept floating-point
   inputs](https://data-apis.org/array-api/latest/API_specification/generated/array_api.sin.html#array_api.sin),
-  so in array-api-strict, `sin(integer_array)` will raise an exception.
+  so in array-api-strict, `sin(asarray(0))` will raise an exception.
 
 - The
   [indexing](https://data-apis.org/array-api/latest/API_specification/indexing.html)
@@ -128,6 +131,12 @@ strict/minimal:
   functions](https://data-apis.org/array-api/latest/API_specification/creation_functions.html)
   such as `asarray`.
 
+- Optional behavior such as [optional
+  extensions](https://data-apis.org/array-api/latest/extensions/index.html),
+  functions that use data-dependent shapes, and boolean indexing are enabled
+  by default but can disabled with the [array-api-strict
+  flags](array-api-strict-flags).
+
 ## Caveats
 
 array-api-strict is a thin pure Python wrapper around NumPy. NumPy 2.0 fully
@@ -167,21 +176,13 @@ issue, but this hasn't necessarily been tested thoroughly.
    this deviation may be tested with type checking. This [behavior may improve
    in the future](https://github.com/data-apis/array-api-strict/issues/6).
 
-5. There are some behaviors in the standard that are not required to be
-   implemented by libraries that cannot support [data dependent
-   shapes](https://data-apis.org/array-api/latest/design_topics/data_dependent_output_shapes.html).
-   This includes [the `unique_*`
-   functions](https://data-apis.org/array-api/latest/API_specification/set_functions.html),
-   [boolean array
-   indexing](https://data-apis.org/array-api/latest/API_specification/indexing.html#boolean-array-indexing),
-   and the
-   [`nonzero`](https://data-apis.org/array-api/latest/API_specification/generated/array_api.nonzero.html)
-   function. array-api-strict currently implements all of these. In the
-   future, [there may be a way to disable them](https://github.com/data-apis/array-api-strict/issues/7).
-
-6. array-api-strict currently only supports the 2022.12 version of the array
-   API standard. [Support for 2023.12 is
-   planned](https://github.com/data-apis/array-api-strict/issues/25).
+5. array-api-strict currently uses the 2022.12 version of the array API
+   standard by default. Support for 2023.12 is implemented but is still
+   experimental and not fully tested. It can be enabled with
+   {func}`array_api_strict.set_array_api_strict_flags(api_version='2023.12')
+   <array_api_strict.set_array_api_strict_flags>` or by setting the
+   environment variable {envvar}`ARRAY_API_STRICT_API_VERSION=2023.12
+   <ARRAY_API_STRICT_API_VERSION>`.
 
 (numpy.array_api)=
 ## Relationship to `numpy.array_api`

api.html

@@ -271,7 +271,7 @@
 support the array API. Rather, it is intended to be used in the test suites of
 consuming libraries to test their array API usage.</p>
 <section id="module-array_api_strict._flags">
-<span id="array-api-strict-flags"></span><h2>Array API Strict Flags<a class="headerlink" href="#module-array_api_strict._flags" title="Link to this heading">¶</a></h2>
+<span id="id1"></span><span id="array-api-strict-flags"></span><h2>Array API Strict Flags<a class="headerlink" href="#module-array_api_strict._flags" title="Link to this heading">¶</a></h2>
 <p>These functions configure global flags that allow array-api-strict to be
 used in different “modes”. These modes include</p>
 <ul class="simple">
@@ -291,6 +291,13 @@
 <p>This function is <strong>not</strong> part of the array API standard. It only exists
 in array-api-strict.</p>
 </div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The <a class="reference external" href="https://data-apis.org/array-api/latest/API_specification/inspection.html">inspection API</a>
+provides a portable way to access most of this information. However, it
+is only present in standard versions starting with 2023.12. The array
+API version can be accessed portably using <code class="code docutils literal notranslate"><span class="pre">xp.__array_api_version__</span></code>.</p>
+</div>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p><em>dict</em> – A dictionary containing the current array-api-strict flags.</p>
@@ -326,46 +333,52 @@
 <dd><p>Set the array-api-strict flags to the specified values.</p>
 <p>Flags are global variables that enable or disable array-api-strict
 behaviors.</p>
+<p>The flags can also be changed by setting <a class="reference internal" href="#environment-variables"><span class="std std-ref">environment variables</span></a>.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>This function is <strong>not</strong> part of the array API standard. It only exists
 in array-api-strict.</p>
 </div>
-<ul>
-<li><p><code class="code docutils literal notranslate"><span class="pre">api_version</span></code>: The version of the standard to use. Supported
-versions are: <code class="docutils literal notranslate"><span class="pre">('2021.12',</span> <span class="pre">'2022.12')</span></code>. The default version number is
+<dl class="field-list">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul>
+<li><p><strong>api_version</strong> (<em>str, optional</em>) – The version of the standard to use. Supported versions are:
+<code class="docutils literal notranslate"><span class="pre">('2021.12',</span> <span class="pre">'2022.12',</span> <span class="pre">'2023.12')</span></code>. The default version number is
 <code class="docutils literal notranslate"><span class="pre">'2022.12'</span></code>.</p>
 <p>Note that 2021.12 is supported, but currently gives the same thing as
 2022.12 (except that the fft extension will be disabled).</p>
+<p>2023.12 support is experimental. Some features in 2023.12 may still be
+missing, and it hasn’t been fully tested. A future version of
+array-api-strict will change the default version to 2023.12.</p>
 </li>
-<li><p><code class="code docutils literal notranslate"><span class="pre">boolean_indexing</span></code>: Whether indexing by a boolean array is supported.
-Note that although boolean array indexing does result in data-dependent
-shapes, this flag is independent of the <code class="code docutils literal notranslate"><span class="pre">data_dependent_shapes</span></code> flag
-(see below).</p></li>
-<li><p><code class="code docutils literal notranslate"><span class="pre">data_dependent_shapes</span></code>: Whether data-dependent shapes are enabled in
-array-api-strict.</p>
-<p>This flag is enabled by default. Array libraries that use computation
+<li><p><strong>boolean_indexing</strong> (<em>bool, optional</em>) – Whether indexing by a boolean array is supported.
+Note that although boolean array indexing does result in
+data-dependent shapes, this flag is independent of the
+<code class="code docutils literal notranslate"><span class="pre">data_dependent_shapes</span></code> flag (see below).</p></li>
+<li><p><strong>data_dependent_shapes</strong> (<em>bool, optional</em>) – Whether data-dependent shapes are enabled in array-api-strict.
+This flag is enabled by default. Array libraries that use computation
 graphs may not be able to support functions whose output shapes depend
 on the input data.</p>
 <p>The functions that make use of data-dependent shapes, and are therefore
 disabled by setting this flag to False are</p>
 <ul class="simple">
-<li><p><code class="code docutils literal notranslate"><span class="pre">unique_all</span></code>, <code class="code docutils literal notranslate"><span class="pre">unique_counts</span></code>, <code class="code docutils literal notranslate"><span class="pre">unique_inverse</span></code>, and <code class="code docutils literal notranslate"><span class="pre">unique_values</span></code>.</p></li>
-<li><p><code class="code docutils literal notranslate"><span class="pre">nonzero</span></code></p></li>
-<li><p><code class="code docutils literal notranslate"><span class="pre">repeat</span></code> when the <code class="code docutils literal notranslate"><span class="pre">repeats</span></code> argument is an array (requires 2023.12
-version of the standard)</p></li>
+<li><p><code class="code docutils literal notranslate"><span class="pre">unique_all()</span></code>, <code class="code docutils literal notranslate"><span class="pre">unique_counts()</span></code>, <code class="code docutils literal notranslate"><span class="pre">unique_inverse()</span></code>, and <code class="code docutils literal notranslate"><span class="pre">unique_values()</span></code>.</p></li>
+<li><p><code class="code docutils literal notranslate"><span class="pre">nonzero()</span></code></p></li>
+<li><p><code class="code docutils literal notranslate"><span class="pre">repeat()</span></code> when the <code class="code docutils literal notranslate"><span class="pre">repeats</span></code> argument is an array (requires the
+2023.12 version of the standard)</p></li>
 </ul>
 <p>Note that while boolean indexing is also data-dependent, it is
 controlled by a separate <code class="code docutils literal notranslate"><span class="pre">boolean_indexing</span></code> flag (see above).</p>
 <p>See
 <a class="reference external" href="https://data-apis.org/array-api/latest/design_topics/data_dependent_output_shapes.html">https://data-apis.org/array-api/latest/design_topics/data_dependent_output_shapes.html</a>
 for more details.</p>
 </li>
-<li><p><code class="code docutils literal notranslate"><span class="pre">enabled_extensions</span></code>: A list of extensions that are enabled in
-array-api-strict. The default is <code class="docutils literal notranslate"><span class="pre">('linalg',</span> <span class="pre">'fft')</span></code>. Note that
-some extensions require a minimum version of the standard.</p></li>
+<li><p><strong>enabled_extensions</strong> (<em>list of str, optional</em>) – A list of extensions that are enabled in array-api-strict. The default
+is <code class="docutils literal notranslate"><span class="pre">('linalg',</span> <span class="pre">'fft')</span></code>. Note that some extensions require a
+minimum version of the standard.</p></li>
 </ul>
-<p>The flags can also be changed by setting <a class="reference internal" href="#environment-variables"><span class="std std-ref">environment variables</span></a>.</p>
+</dd>
+</dl>
 <p class="rubric">Examples</p>
 <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">array_api_strict</span> <span class="kn">import</span> <span class="n">set_array_api_strict_flags</span>
 </pre></div>
@@ -451,7 +464,7 @@
 </dd></dl>
 
 <section id="environment-variables">
-<span id="id1"></span><h3>Environment Variables<a class="headerlink" href="#environment-variables" title="Link to this heading">¶</a></h3>
+<span id="id2"></span><h3>Environment Variables<a class="headerlink" href="#environment-variables" title="Link to this heading">¶</a></h3>
 <p>Flags can also be set with environment variables.
 <a class="reference internal" href="#array_api_strict.set_array_api_strict_flags" title="array_api_strict.set_array_api_strict_flags"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_array_api_strict_flags()</span></code></a> will override the values set by environment
 variables. Note that the environment variables will only change the defaults

changelog.html

@@ -259,14 +259,44 @@
           <section class="tex2jax_ignore mathjax_ignore" id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading">¶</a></h1>
 <section id="id1">
-<h2>1.1.1 (2024-04-29)<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h2>
+<h2>2.0 (2024-06-27)<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h2>
+<section id="major-changes">
+<h3>Major Changes<a class="headerlink" href="#major-changes" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p>array-api-strict has a new set of <a class="reference internal" href="api.html#array-api-strict-flags"><span class="std std-ref">flags</span></a> that can
+be used to dynamically enable or disable features in array-api-strict. These
+flags allow you to change the supported array API version, enable or disable
+<a class="reference external" href="https://data-apis.org/array-api/latest/extensions/index.html">extensions</a>,
+enable or disable features that rely on data-dependent shapes, and enable or
+disable boolean indexing. Future versions may add additional flags to allow
+changing other optional or varying behaviors in the standard.</p></li>
+<li><p>Added experimental support for the
+<a class="reference external" href="https://data-apis.org/array-api/2023.12/changelog.html#v2023-12">2023.12</a>
+version of the array API standard. The default version is still 2022.12, but
+the version can be changed to 2023.12 using the aforementioned flags, either
+by calling
+<a class="reference internal" href="api.html#array_api_strict.set_array_api_strict_flags" title="array_api_strict.set_array_api_strict_flags"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_api_strict.set_array_api_strict_flags(api_version='2023.12')</span></code></a> or setting the environment
+variable <span class="target" id="index-0"></span><a class="reference internal" href="api.html#envvar-ARRAY_API_STRICT_API_VERSION"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ARRAY_API_STRICT_API_VERSION=2023.12</span></code></a>. A future version of array-api-strict will
+change the default version to 2023.12.</p></li>
+</ul>
+</section>
+<section id="minor-changes">
+<h3>Minor Changes<a class="headerlink" href="#minor-changes" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p>Calling <code class="docutils literal notranslate"><span class="pre">iter()</span></code> on an array now correctly raises <code class="docutils literal notranslate"><span class="pre">TypeError</span></code>.</p></li>
+<li><p>Add some missing names to <code class="docutils literal notranslate"><span class="pre">__all__</span></code>.</p></li>
+</ul>
+</section>
+</section>
+<section id="id2">
+<h2>1.1.1 (2024-04-29)<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Fix the <code class="docutils literal notranslate"><span class="pre">api_version</span></code> argument to <code class="docutils literal notranslate"><span class="pre">__array_namespace__</span></code> to accept
 <code class="docutils literal notranslate"><span class="pre">'2021.12'</span></code> or <code class="docutils literal notranslate"><span class="pre">'2022.12'</span></code>.</p></li>
 </ul>
 </section>
-<section id="id2">
-<h2>1.1 (2024-04-08)<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h2>
+<section id="id3">
+<h2>1.1 (2024-04-08)<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Fix the <code class="docutils literal notranslate"><span class="pre">copy</span></code> flag in <code class="docutils literal notranslate"><span class="pre">__array__</span></code> for NumPy 2.0.</p></li>
 <li><p>Add full <code class="docutils literal notranslate"><span class="pre">copy=False</span></code> support to <code class="docutils literal notranslate"><span class="pre">asarray()</span></code>. This is emulated in NumPy 1.26 by creating
@@ -275,8 +305,8 @@ <h2>1.1 (2024-04-08)<a class="headerlink" href="#id2" title="Link to this headin
 <li><p>Add broadcasting support to <code class="docutils literal notranslate"><span class="pre">cross</span></code>.</p></li>
 </ul>
 </section>
-<section id="id3">
-<h2>1.0 (2024-01-24)<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h2>
+<section id="id4">
+<h2>1.0 (2024-01-24)<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h2>
 <p>This is the first release of <code class="docutils literal notranslate"><span class="pre">array_api_strict</span></code>. It is extracted from
 <code class="docutils literal notranslate"><span class="pre">numpy.array_api</span></code>, which was included as an experimental submodule in NumPy
 versions prior to 2.0. Note that the commit history in this repository is
@@ -360,9 +390,14 @@ <h2>1.0 (2024-01-24)<a class="headerlink" href="#id3" title="Link to this headin
           <div class="toc-tree">
             <ul>
 <li><a class="reference internal" href="#">Changelog</a><ul>
-<li><a class="reference internal" href="#id1">1.1.1 (2024-04-29)</a></li>
-<li><a class="reference internal" href="#id2">1.1 (2024-04-08)</a></li>
-<li><a class="reference internal" href="#id3">1.0 (2024-01-24)</a></li>
+<li><a class="reference internal" href="#id1">2.0 (2024-06-27)</a><ul>
+<li><a class="reference internal" href="#major-changes">Major Changes</a></li>
+<li><a class="reference internal" href="#minor-changes">Minor Changes</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#id2">1.1.1 (2024-04-29)</a></li>
+<li><a class="reference internal" href="#id3">1.1 (2024-04-08)</a></li>
+<li><a class="reference internal" href="#id4">1.0 (2024-01-24)</a></li>
 </ul>
 </li>
 </ul>