Skip to content

Commit 6b4facf

Browse files
Update docs
1 parent 319b806 commit 6b4facf

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

_sources/autoapi/tilelang/language/atomic/index.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Module Contents
106106
>>> atomic_min(min_val, 5, memory_order="relaxed")
107107

108108

109-
.. py:function:: atomic_add(dst, value, memory_order = None, return_prev = False)
109+
.. py:function:: atomic_add(dst, value, memory_order = None, return_prev = False, use_tma = False)
110110
111111
Atomically add `value` into `dst`, returning a handle to the operation.
112112

autoapi/tilelang/language/atomic/index.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
490490
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.language.atomic.atomic_min" title="tilelang.language.atomic.atomic_min"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atomic_min</span></code></a>(dst, value[, memory_order, return_prev])</p></td>
491491
<td><p>Atomically update the value at dst to the minimum of its current value and value.</p></td>
492492
</tr>
493-
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.language.atomic.atomic_add" title="tilelang.language.atomic.atomic_add"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atomic_add</span></code></a>(dst, value[, memory_order, return_prev])</p></td>
493+
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.language.atomic.atomic_add" title="tilelang.language.atomic.atomic_add"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atomic_add</span></code></a>(dst, value[, memory_order, return_prev, ...])</p></td>
494494
<td><p>Atomically add <cite>value</cite> into <cite>dst</cite>, returning a handle to the operation.</p></td>
495495
</tr>
496496
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.language.atomic.atomic_addx2" title="tilelang.language.atomic.atomic_addx2"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atomic_addx2</span></code></a>(dst, value[, return_prev])</p></td>
@@ -607,7 +607,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
607607

608608
<dl class="py function">
609609
<dt class="sig sig-object py" id="tilelang.language.atomic.atomic_add">
610-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.atomic.</span></span><span class="sig-name descname"><span class="pre">atomic_add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dst</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_order</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">return_prev</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.atomic.atomic_add" title="Link to this definition"></a></dt>
610+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.atomic.</span></span><span class="sig-name descname"><span class="pre">atomic_add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dst</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_order</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">return_prev</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_tma</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.atomic.atomic_add" title="Link to this definition"></a></dt>
611611
<dd><p>Atomically add <cite>value</cite> into <cite>dst</cite>, returning a handle to the operation.</p>
612612
<p>Supports scalar/addressed extern atomic add when neither argument exposes extents, or tile-region-based atomic add for Buffer/BufferRegion/BufferLoad inputs. If both arguments are plain Buffers their shapes must be structurally equal. If at least one side exposes extents, extents are aligned (missing dimensions are treated as size 1); an assertion is raised if extents cannot be deduced. The optional <cite>memory_order</cite> (one of “relaxed”,”consume”,”acquire”,”release”,”acq_rel”,”seq_cst”) is used only for the direct extern <cite>AtomicAdd</cite> path when no extents are available — otherwise the tile-region path ignores <cite>memory_order</cite>.</p>
613613
<dl class="field-list simple">
@@ -617,6 +617,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
617617
<li><p><strong>value</strong> (<em>PrimExpr</em>) – Value to add atomically.</p></li>
618618
<li><p><strong>memory_order</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) – Optional memory-order name controlling the atomic operation’s ordering.</p></li>
619619
<li><p><strong>return_prev</strong> (<em>bool</em>) – If True, return the previous value; if False, return handle (default False).</p></li>
620+
<li><p><strong>use_tma</strong> (<em>bool</em>)</p></li>
620621
</ul>
621622
</dd>
622623
<dt class="field-even">Returns<span class="colon">:</span></dt>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)