Skip to content

Commit f0ca832

Browse files
committed
Deploying to gh-pages from @ b1303a1 🚀
1 parent 48a9041 commit f0ca832

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

api.html

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -351,8 +351,8 @@
351351
missing, and it hasn’t been fully tested. A future version of
352352
array-api-strict will change the default version to 2023.12.</p>
353353
</li>
354-
<li><p><strong>boolean_indexing</strong> (<em>bool, optional</em>) – Whether indexing by a boolean array is supported.
355-
Note that although boolean array indexing does result in
354+
<li><p><strong>boolean_indexing</strong> (<em>bool, optional</em>) – Whether indexing by a boolean array is supported. This flag is enabled
355+
by default. Note that although boolean array indexing does result in
356356
data-dependent shapes, this flag is independent of the
357357
<code class="code docutils literal notranslate"><span class="pre">data_dependent_shapes</span></code> flag (see below).</p></li>
358358
<li><p><strong>data_dependent_shapes</strong> (<em>bool, optional</em>) – Whether data-dependent shapes are enabled in array-api-strict.
@@ -450,6 +450,18 @@
450450
</div>
451451
<p>See <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> for a
452452
description of the available flags.</p>
453+
<p class="rubric">Examples</p>
454+
<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">ArrayAPIStrictFlags</span><span class="p">,</span> <span class="n">get_array_api_strict_flags</span>
455+
<span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">ArrayAPIStrictFlags</span><span class="p">(</span><span class="n">api_version</span><span class="o">=</span><span class="s2">&quot;2022.12&quot;</span><span class="p">,</span> <span class="n">boolean_indexing</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
456+
<span class="gp">... </span> <span class="n">flags</span> <span class="o">=</span> <span class="n">get_array_api_strict_flags</span><span class="p">()</span>
457+
<span class="gp">&gt;&gt;&gt; </span><span class="n">flags</span>
458+
<span class="go">{&#39;api_version&#39;: &#39;2022.12&#39;,</span>
459+
<span class="go"> &#39;boolean_indexing&#39;: False,</span>
460+
<span class="go"> &#39;data_dependent_shapes&#39;: True,</span>
461+
<span class="go"> &#39;enabled_extensions&#39;: (&#39;linalg&#39;, &#39;fft&#39;)</span>
462+
<span class="go">}</span>
463+
</pre></div>
464+
</div>
453465
<div class="admonition seealso">
454466
<p class="admonition-title">See also</p>
455467
<dl class="simple">

0 commit comments

Comments
 (0)