Skip to content

Commit a75f870

Browse files
committed
Update docs
1 parent c8e803e commit a75f870

13 files changed

+127
-32
lines changed

api/tilelang.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -807,8 +807,10 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
807807
<li class="toctree-l3"><a class="reference internal" href="tilelang.language.builtin.html">tilelang.language.builtin module</a><ul>
808808
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.create_list_of_mbarrier"><code class="docutils literal notranslate"><span class="pre">create_list_of_mbarrier()</span></code></a></li>
809809
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.create_tma_descriptor"><code class="docutils literal notranslate"><span class="pre">create_tma_descriptor()</span></code></a></li>
810+
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.dec_max_nreg"><code class="docutils literal notranslate"><span class="pre">dec_max_nreg()</span></code></a></li>
810811
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.fence_proxy_async"><code class="docutils literal notranslate"><span class="pre">fence_proxy_async()</span></code></a></li>
811812
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.get_mbarrier"><code class="docutils literal notranslate"><span class="pre">get_mbarrier()</span></code></a></li>
813+
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.inc_max_nreg"><code class="docutils literal notranslate"><span class="pre">inc_max_nreg()</span></code></a></li>
812814
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.mbarrier_arrive"><code class="docutils literal notranslate"><span class="pre">mbarrier_arrive()</span></code></a></li>
813815
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.mbarrier_expect_tx"><code class="docutils literal notranslate"><span class="pre">mbarrier_expect_tx()</span></code></a></li>
814816
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.mbarrier_wait_parity"><code class="docutils literal notranslate"><span class="pre">mbarrier_wait_parity()</span></code></a></li>
@@ -998,6 +1000,10 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
9981000
<li class="toctree-l1"><a class="reference internal" href="tilelang.testing.html">tilelang.testing package</a><ul>
9991001
<li class="toctree-l2"><a class="reference internal" href="tilelang.testing.html#module-tilelang.testing">Module contents</a><ul>
10001002
<li class="toctree-l3"><a class="reference internal" href="tilelang.testing.html#tilelang.testing.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
1003+
<li class="toctree-l3"><a class="reference internal" href="tilelang.testing.html#tilelang.testing.requires_cuda_compute_version"><code class="docutils literal notranslate"><span class="pre">requires_cuda_compute_version()</span></code></a></li>
1004+
<li class="toctree-l3"><a class="reference internal" href="tilelang.testing.html#tilelang.testing.requires_cuda_compute_version_eq"><code class="docutils literal notranslate"><span class="pre">requires_cuda_compute_version_eq()</span></code></a></li>
1005+
<li class="toctree-l3"><a class="reference internal" href="tilelang.testing.html#tilelang.testing.requires_cuda_compute_version_ge"><code class="docutils literal notranslate"><span class="pre">requires_cuda_compute_version_ge()</span></code></a></li>
1006+
<li class="toctree-l3"><a class="reference internal" href="tilelang.testing.html#tilelang.testing.requires_cuda_compute_version_gt"><code class="docutils literal notranslate"><span class="pre">requires_cuda_compute_version_gt()</span></code></a></li>
10011007
<li class="toctree-l3"><a class="reference internal" href="tilelang.testing.html#tilelang.testing.set_random_seed"><code class="docutils literal notranslate"><span class="pre">set_random_seed()</span></code></a></li>
10021008
</ul>
10031009
</li>

api/tilelang.jit.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
520520
“tl.disable_warp_specialized”: bool, default: False
521521
“tl.config_index_bitwidth”: int, default: None
522522
“tl.disable_dynamic_tail_split”: bool, default: False
523-
“tl.dynamic_vectorize_size_bits”: int, default: 128</p>
523+
“tl.dynamic_vectorize_size_bits”: int, default: 128
524+
“tl.disable_safe_memory_legalize”: bool, default: False</p>
524525
</dd>
525526
</dl>
526527
</div></blockquote>

api/tilelang.language.builtin.html

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,12 @@
446446
</dl>
447447
</dd></dl>
448448

449+
<dl class="py function">
450+
<dt class="sig sig-object py" id="tilelang.language.builtin.dec_max_nreg">
451+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">dec_max_nreg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reg_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.dec_max_nreg" title="Permalink to this definition">#</a></dt>
452+
<dd><p>Decrement the maximum number of registers to use.</p>
453+
</dd></dl>
454+
449455
<dl class="py function">
450456
<dt class="sig sig-object py" id="tilelang.language.builtin.fence_proxy_async">
451457
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">fence_proxy_async</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.fence_proxy_async" title="Permalink to this definition">#</a></dt>
@@ -480,6 +486,12 @@
480486
</dl>
481487
</dd></dl>
482488

489+
<dl class="py function">
490+
<dt class="sig sig-object py" id="tilelang.language.builtin.inc_max_nreg">
491+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">inc_max_nreg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reg_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.inc_max_nreg" title="Permalink to this definition">#</a></dt>
492+
<dd><p>Increment the maximum number of registers to use.</p>
493+
</dd></dl>
494+
483495
<dl class="py function">
484496
<dt class="sig sig-object py" id="tilelang.language.builtin.mbarrier_arrive">
485497
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">mbarrier_arrive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mbarrier</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">PrimExpr</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Call</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.mbarrier_arrive" title="Permalink to this definition">#</a></dt>
@@ -563,28 +575,25 @@
563575

564576
<dl class="py function">
565577
<dt class="sig sig-object py" id="tilelang.language.builtin.no_set_max_nreg">
566-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">no_set_max_nreg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.no_set_max_nreg" title="Permalink to this definition">#</a></dt>
578+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">no_set_max_nreg</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.no_set_max_nreg" title="Permalink to this definition">#</a></dt>
567579
<dd><p>Disable the maximum register limit setting.</p>
568-
<dl class="field-list simple">
569-
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
570-
<dd class="field-odd"><p><strong>*args</strong> – Variable arguments for the operation</p>
571-
</dd>
572-
<dt class="field-even">Returns<span class="colon">:</span></dt>
573-
<dd class="field-even"><p>A handle to the register limit disable operation</p>
574-
</dd>
575-
<dt class="field-odd">Return type<span class="colon">:</span></dt>
576-
<dd class="field-odd"><p>tir.Call</p>
577-
</dd>
578-
</dl>
579580
</dd></dl>
580581

581582
<dl class="py function">
582583
<dt class="sig sig-object py" id="tilelang.language.builtin.set_max_nreg">
583-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">set_max_nreg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.set_max_nreg" title="Permalink to this definition">#</a></dt>
584-
<dd><p>Set the maximum number of registers to use.</p>
584+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">set_max_nreg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reg_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_inc</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.set_max_nreg" title="Permalink to this definition">#</a></dt>
585+
<dd><p>Set the maximum number of registers to use.
586+
Detailed Documentation:
587+
<a class="reference external" href="https://docs.nvidia.com/cuda/parallel-thread-execution/#miscellaneous-instructions-setmaxnreg">https://docs.nvidia.com/cuda/parallel-thread-execution/#miscellaneous-instructions-setmaxnreg</a></p>
585588
<dl class="field-list simple">
586589
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
587-
<dd class="field-odd"><p><strong>*args</strong> – Variable arguments specifying register allocation limits</p>
590+
<dd class="field-odd"><ul class="simple">
591+
<li><p><strong>reg_count</strong> – int
592+
The number of registers to allocate</p></li>
593+
<li><p><strong>is_inc</strong> – int
594+
Whether to increment or decrement the register count
595+
0 if decrement, 1 if increment</p></li>
596+
</ul>
588597
</dd>
589598
<dt class="field-even">Returns<span class="colon">:</span></dt>
590599
<dd class="field-even"><p>A handle to the register setting operation</p>
@@ -723,8 +732,10 @@
723732
<li><a class="reference internal" href="#">tilelang.language.builtin module</a><ul>
724733
<li><a class="reference internal" href="#tilelang.language.builtin.create_list_of_mbarrier"><code class="docutils literal notranslate"><span class="pre">create_list_of_mbarrier()</span></code></a></li>
725734
<li><a class="reference internal" href="#tilelang.language.builtin.create_tma_descriptor"><code class="docutils literal notranslate"><span class="pre">create_tma_descriptor()</span></code></a></li>
735+
<li><a class="reference internal" href="#tilelang.language.builtin.dec_max_nreg"><code class="docutils literal notranslate"><span class="pre">dec_max_nreg()</span></code></a></li>
726736
<li><a class="reference internal" href="#tilelang.language.builtin.fence_proxy_async"><code class="docutils literal notranslate"><span class="pre">fence_proxy_async()</span></code></a></li>
727737
<li><a class="reference internal" href="#tilelang.language.builtin.get_mbarrier"><code class="docutils literal notranslate"><span class="pre">get_mbarrier()</span></code></a></li>
738+
<li><a class="reference internal" href="#tilelang.language.builtin.inc_max_nreg"><code class="docutils literal notranslate"><span class="pre">inc_max_nreg()</span></code></a></li>
728739
<li><a class="reference internal" href="#tilelang.language.builtin.mbarrier_arrive"><code class="docutils literal notranslate"><span class="pre">mbarrier_arrive()</span></code></a></li>
729740
<li><a class="reference internal" href="#tilelang.language.builtin.mbarrier_expect_tx"><code class="docutils literal notranslate"><span class="pre">mbarrier_expect_tx()</span></code></a></li>
730741
<li><a class="reference internal" href="#tilelang.language.builtin.mbarrier_wait_parity"><code class="docutils literal notranslate"><span class="pre">mbarrier_wait_parity()</span></code></a></li>

api/tilelang.language.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -585,8 +585,10 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
585585
<li class="toctree-l1"><a class="reference internal" href="tilelang.language.builtin.html">tilelang.language.builtin module</a><ul>
586586
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.create_list_of_mbarrier"><code class="docutils literal notranslate"><span class="pre">create_list_of_mbarrier()</span></code></a></li>
587587
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.create_tma_descriptor"><code class="docutils literal notranslate"><span class="pre">create_tma_descriptor()</span></code></a></li>
588+
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.dec_max_nreg"><code class="docutils literal notranslate"><span class="pre">dec_max_nreg()</span></code></a></li>
588589
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.fence_proxy_async"><code class="docutils literal notranslate"><span class="pre">fence_proxy_async()</span></code></a></li>
589590
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.get_mbarrier"><code class="docutils literal notranslate"><span class="pre">get_mbarrier()</span></code></a></li>
591+
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.inc_max_nreg"><code class="docutils literal notranslate"><span class="pre">inc_max_nreg()</span></code></a></li>
590592
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.mbarrier_arrive"><code class="docutils literal notranslate"><span class="pre">mbarrier_arrive()</span></code></a></li>
591593
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.mbarrier_expect_tx"><code class="docutils literal notranslate"><span class="pre">mbarrier_expect_tx()</span></code></a></li>
592594
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.mbarrier_wait_parity"><code class="docutils literal notranslate"><span class="pre">mbarrier_wait_parity()</span></code></a></li>

api/tilelang.language.logical.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@
406406
<p>The language interface for tl programs.</p>
407407
<dl class="py function">
408408
<dt class="sig sig-object py" id="tilelang.language.logical.all_of">
409-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.logical.</span></span><span class="sig-name descname"><span class="pre">all_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">buffer:</span> <span class="pre">~typing.Union[&lt;tilelang.language.proxy.TensorProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f42caca3310&gt;,</span> <span class="pre">~tvm.tir.stmt.BufferRegion]</span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.logical.all_of" title="Permalink to this definition">#</a></dt>
409+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.logical.</span></span><span class="sig-name descname"><span class="pre">all_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">buffer:</span> <span class="pre">~typing.Union[&lt;tilelang.language.proxy.TensorProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f2167a05fc0&gt;,</span> <span class="pre">~tvm.tir.stmt.BufferRegion]</span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.logical.all_of" title="Permalink to this definition">#</a></dt>
410410
<dd><p>Check if all elements in the buffer are true.</p>
411411
<dl class="field-list simple">
412412
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -420,7 +420,7 @@
420420

421421
<dl class="py function">
422422
<dt class="sig sig-object py" id="tilelang.language.logical.any_of">
423-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.logical.</span></span><span class="sig-name descname"><span class="pre">any_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">buffer:</span> <span class="pre">~typing.Union[&lt;tilelang.language.proxy.TensorProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f42caca3310&gt;,</span> <span class="pre">~tvm.tir.stmt.BufferRegion]</span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.logical.any_of" title="Permalink to this definition">#</a></dt>
423+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.logical.</span></span><span class="sig-name descname"><span class="pre">any_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">buffer:</span> <span class="pre">~typing.Union[&lt;tilelang.language.proxy.TensorProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f2167a05fc0&gt;,</span> <span class="pre">~tvm.tir.stmt.BufferRegion]</span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.logical.any_of" title="Permalink to this definition">#</a></dt>
424424
<dd><p>Check if any element in the buffer is true.</p>
425425
<dl class="field-list simple">
426426
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

0 commit comments

Comments
 (0)