|
5 | 5 | <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> |
6 | 6 | <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Changelog" href="changelog.html" /><link rel="prev" title="array-api-strict" href="index.html" /> |
7 | 7 |
|
8 | | - <link rel="shortcut icon" href="_static/favicon.png"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> |
| 8 | + <link rel="shortcut icon" href="_static/favicon.png"/><!-- Generated with Sphinx 8.2.1 and Furo 2024.08.06 --> |
9 | 9 | <title>API Reference - array-api-strict documentation</title> |
10 | 10 | <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> |
11 | 11 | <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> |
|
317 | 317 |
|
318 | 318 | <dl class="py function"> |
319 | 319 | <dt class="sig sig-object py" id="array_api_strict.set_array_api_strict_flags"> |
320 | | -<span class="sig-prename descclassname"><span class="pre">array_api_strict.</span></span><span class="sig-name descname"><span class="pre">set_array_api_strict_flags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boolean_indexing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_dependent_shapes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled_extensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#array_api_strict.set_array_api_strict_flags" title="Link to this definition">¶</a></dt> |
| 320 | +<span class="sig-prename descclassname"><span class="pre">array_api_strict.</span></span><span class="sig-name descname"><span class="pre">set_array_api_strict_flags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boolean_indexing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_dependent_shapes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled_extensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#array_api_strict.set_array_api_strict_flags" title="Link to this definition">¶</a></dt> |
321 | 321 | <dd><p>Set the array-api-strict flags to the specified values.</p> |
322 | 322 | <p>Flags are global variables that enable or disable array-api-strict |
323 | 323 | behaviors.</p> |
|
331 | 331 | <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
332 | 332 | <dd class="field-odd"><ul> |
333 | 333 | <li><p><strong>api_version</strong> (<em>str, optional</em>) – The version of the standard to use. Supported versions are: |
334 | | -<code class="docutils literal notranslate"><span class="pre">('2021.12',</span> <span class="pre">'2022.12',</span> <span class="pre">'2023.12')</span></code>, plus the draft version <code class="docutils literal notranslate"><span class="pre">2024.12</span></code>. |
335 | | -The default version number is <code class="docutils literal notranslate"><span class="pre">'2023.12'</span></code>.</p> |
| 334 | +<code class="docutils literal notranslate"><span class="pre">('2021.12',</span> <span class="pre">'2022.12',</span> <span class="pre">'2023.12',</span> <span class="pre">'2024.12')</span></code>, plus the draft version <code class="docutils literal notranslate"><span class="pre">2025.12</span></code>. |
| 335 | +The default version number is <code class="docutils literal notranslate"><span class="pre">'2024.12'</span></code>.</p> |
336 | 336 | <p>Note that 2021.12 is supported, but currently gives the same thing as |
337 | 337 | 2022.12 (except that the fft extension will be disabled).</p> |
338 | 338 | </li> |
|
426 | 426 |
|
427 | 427 | <dl class="py class"> |
428 | 428 | <dt class="sig sig-object py" id="array_api_strict.ArrayAPIStrictFlags"> |
429 | | -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">array_api_strict.</span></span><span class="sig-name descname"><span class="pre">ArrayAPIStrictFlags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boolean_indexing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_dependent_shapes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled_extensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#array_api_strict.ArrayAPIStrictFlags" title="Link to this definition">¶</a></dt> |
| 429 | +<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">array_api_strict.</span></span><span class="sig-name descname"><span class="pre">ArrayAPIStrictFlags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boolean_indexing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_dependent_shapes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled_extensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#array_api_strict.ArrayAPIStrictFlags" title="Link to this definition">¶</a></dt> |
430 | 430 | <dd><p>A context manager to temporarily set the array-api-strict flags.</p> |
431 | 431 | <div class="admonition note"> |
432 | 432 | <p class="admonition-title">Note</p> |
|
0 commit comments