|
272 | 272 | library will only support one particular configuration of these flags.</p> |
273 | 273 | <dl class="py function"> |
274 | 274 | <dt class="sig sig-object py" id="array_api_strict.get_array_api_strict_flags"> |
275 | | -<span class="sig-prename descclassname"><span class="pre">array_api_strict.</span></span><span class="sig-name descname"><span class="pre">get_array_api_strict_flags</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#array_api_strict.get_array_api_strict_flags" title="Link to this definition">¶</a></dt> |
| 275 | +<span class="sig-prename descclassname"><span class="pre">array_api_strict.</span></span><span class="sig-name descname"><span class="pre">get_array_api_strict_flags</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#array_api_strict.get_array_api_strict_flags" title="Link to this definition">¶</a></dt> |
276 | 276 | <dd><p>Get the current array-api-strict flags.</p> |
277 | 277 | <div class="admonition note"> |
278 | 278 | <p class="admonition-title">Note</p> |
|
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="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> |
| 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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Collection</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></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> |
|
395 | 395 |
|
396 | 396 | <dl class="py function"> |
397 | 397 | <dt class="sig sig-object py" id="array_api_strict.reset_array_api_strict_flags"> |
398 | | -<span class="sig-prename descclassname"><span class="pre">array_api_strict.</span></span><span class="sig-name descname"><span class="pre">reset_array_api_strict_flags</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#array_api_strict.reset_array_api_strict_flags" title="Link to this definition">¶</a></dt> |
| 398 | +<span class="sig-prename descclassname"><span class="pre">array_api_strict.</span></span><span class="sig-name descname"><span class="pre">reset_array_api_strict_flags</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#array_api_strict.reset_array_api_strict_flags" title="Link to this definition">¶</a></dt> |
399 | 399 | <dd><p>Reset the array-api-strict flags to their default values.</p> |
400 | 400 | <p>This will also reset any flags that were set by <a class="reference internal" href="#environment-variables"><span class="std std-ref">environment |
401 | 401 | variables</span></a> back to their default values.</p> |
|
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="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> |
| 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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Collection</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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