Skip to content

Commit 59019a4

Browse files
committed
Update docs
1 parent 5bc2688 commit 59019a4

13 files changed

+55
-8
lines changed

api/tilelang.carver.arch.driver.cuda_driver.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -875,6 +875,11 @@
875875
</dl>
876876
</dd></dl>
877877

878+
<dl class="py function">
879+
<dt class="sig sig-object py" id="tilelang.carver.arch.driver.cuda_driver.get_persisting_l2_cache_max_size">
880+
<span class="sig-prename descclassname"><span class="pre">tilelang.carver.arch.driver.cuda_driver.</span></span><span class="sig-name descname"><span class="pre">get_persisting_l2_cache_max_size</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#tilelang.carver.arch.driver.cuda_driver.get_persisting_l2_cache_max_size" title="Permalink to this definition">#</a></dt>
881+
<dd></dd></dl>
882+
878883
<dl class="py function">
879884
<dt class="sig sig-object py" id="tilelang.carver.arch.driver.cuda_driver.get_shared_memory_per_block">
880885
<span class="sig-prename descclassname"><span class="pre">tilelang.carver.arch.driver.cuda_driver.</span></span><span class="sig-name descname"><span class="pre">get_shared_memory_per_block</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'bytes'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#tilelang.carver.arch.driver.cuda_driver.get_shared_memory_per_block" title="Permalink to this definition">#</a></dt>
@@ -1015,6 +1020,7 @@
10151020
<li><a class="reference internal" href="#tilelang.carver.arch.driver.cuda_driver.get_device_name"><code class="docutils literal notranslate"><span class="pre">get_device_name()</span></code></a></li>
10161021
<li><a class="reference internal" href="#tilelang.carver.arch.driver.cuda_driver.get_max_dynamic_shared_size_bytes"><code class="docutils literal notranslate"><span class="pre">get_max_dynamic_shared_size_bytes()</span></code></a></li>
10171022
<li><a class="reference internal" href="#tilelang.carver.arch.driver.cuda_driver.get_num_sms"><code class="docutils literal notranslate"><span class="pre">get_num_sms()</span></code></a></li>
1023+
<li><a class="reference internal" href="#tilelang.carver.arch.driver.cuda_driver.get_persisting_l2_cache_max_size"><code class="docutils literal notranslate"><span class="pre">get_persisting_l2_cache_max_size()</span></code></a></li>
10181024
<li><a class="reference internal" href="#tilelang.carver.arch.driver.cuda_driver.get_shared_memory_per_block"><code class="docutils literal notranslate"><span class="pre">get_shared_memory_per_block()</span></code></a></li>
10191025
</ul>
10201026
</li>

api/tilelang.carver.arch.driver.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
496496
<li class="toctree-l2"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_device_name"><code class="docutils literal notranslate"><span class="pre">get_device_name()</span></code></a></li>
497497
<li class="toctree-l2"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_max_dynamic_shared_size_bytes"><code class="docutils literal notranslate"><span class="pre">get_max_dynamic_shared_size_bytes()</span></code></a></li>
498498
<li class="toctree-l2"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_num_sms"><code class="docutils literal notranslate"><span class="pre">get_num_sms()</span></code></a></li>
499+
<li class="toctree-l2"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_persisting_l2_cache_max_size"><code class="docutils literal notranslate"><span class="pre">get_persisting_l2_cache_max_size()</span></code></a></li>
499500
<li class="toctree-l2"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_shared_memory_per_block"><code class="docutils literal notranslate"><span class="pre">get_shared_memory_per_block()</span></code></a></li>
500501
</ul>
501502
</li>

api/tilelang.carver.arch.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
427427
<li class="toctree-l4"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_device_name"><code class="docutils literal notranslate"><span class="pre">get_device_name()</span></code></a></li>
428428
<li class="toctree-l4"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_max_dynamic_shared_size_bytes"><code class="docutils literal notranslate"><span class="pre">get_max_dynamic_shared_size_bytes()</span></code></a></li>
429429
<li class="toctree-l4"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_num_sms"><code class="docutils literal notranslate"><span class="pre">get_num_sms()</span></code></a></li>
430+
<li class="toctree-l4"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_persisting_l2_cache_max_size"><code class="docutils literal notranslate"><span class="pre">get_persisting_l2_cache_max_size()</span></code></a></li>
430431
<li class="toctree-l4"><a class="reference internal" href="tilelang.carver.arch.driver.cuda_driver.html#tilelang.carver.arch.driver.cuda_driver.get_shared_memory_per_block"><code class="docutils literal notranslate"><span class="pre">get_shared_memory_per_block()</span></code></a></li>
431432
</ul>
432433
</li>

api/tilelang.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -898,6 +898,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
898898
</ul>
899899
</li>
900900
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.html#module-tilelang.language">Module contents</a><ul>
901+
<li class="toctree-l3"><a class="reference internal" href="tilelang.language.html#tilelang.language.annotate_l2_hit_ratio"><code class="docutils literal notranslate"><span class="pre">annotate_l2_hit_ratio()</span></code></a></li>
901902
<li class="toctree-l3"><a class="reference internal" href="tilelang.language.html#tilelang.language.annotate_layout"><code class="docutils literal notranslate"><span class="pre">annotate_layout()</span></code></a></li>
902903
<li class="toctree-l3"><a class="reference internal" href="tilelang.language.html#tilelang.language.annotate_padding"><code class="docutils literal notranslate"><span class="pre">annotate_padding()</span></code></a></li>
903904
<li class="toctree-l3"><a class="reference internal" href="tilelang.language.html#tilelang.language.import_source"><code class="docutils literal notranslate"><span class="pre">import_source()</span></code></a></li>
@@ -1049,6 +1050,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
10491050
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LoopVectorizeDynamic"><code class="docutils literal notranslate"><span class="pre">LoopVectorizeDynamic()</span></code></a></li>
10501051
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LowerDeviceStorageAccessInfo"><code class="docutils literal notranslate"><span class="pre">LowerDeviceStorageAccessInfo()</span></code></a></li>
10511052
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LowerHopperIntrin"><code class="docutils literal notranslate"><span class="pre">LowerHopperIntrin()</span></code></a></li>
1053+
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LowerL2Persistent"><code class="docutils literal notranslate"><span class="pre">LowerL2Persistent()</span></code></a></li>
10521054
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LowerTileOp"><code class="docutils literal notranslate"><span class="pre">LowerTileOp()</span></code></a></li>
10531055
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.MakePackedAPI"><code class="docutils literal notranslate"><span class="pre">MakePackedAPI()</span></code></a></li>
10541056
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.MergeIfStmt"><code class="docutils literal notranslate"><span class="pre">MergeIfStmt()</span></code></a></li>

api/tilelang.jit.adapter.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -517,6 +517,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
517517
<li class="toctree-l3"><a class="reference internal" href="tilelang.jit.adapter.wrapper.html#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.backend"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.backend</span></code></a></li>
518518
<li class="toctree-l3"><a class="reference internal" href="tilelang.jit.adapter.wrapper.html#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.create_dispatch_func"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.create_dispatch_func()</span></code></a></li>
519519
<li class="toctree-l3"><a class="reference internal" href="tilelang.jit.adapter.wrapper.html#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.device_mod"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.device_mod</span></code></a></li>
520+
<li class="toctree-l3"><a class="reference internal" href="tilelang.jit.adapter.wrapper.html#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.generate_l2_persistent_map"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.generate_l2_persistent_map()</span></code></a></li>
520521
<li class="toctree-l3"><a class="reference internal" href="tilelang.jit.adapter.wrapper.html#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.generate_tma_descriptor_args"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.generate_tma_descriptor_args()</span></code></a></li>
521522
<li class="toctree-l3"><a class="reference internal" href="tilelang.jit.adapter.wrapper.html#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.get_dynamic_symbolic_set"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.get_dynamic_symbolic_set()</span></code></a></li>
522523
<li class="toctree-l3"><a class="reference internal" href="tilelang.jit.adapter.wrapper.html#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.get_init_func"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.get_init_func()</span></code></a></li>

api/tilelang.jit.adapter.wrapper.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -510,6 +510,11 @@
510510
<span class="sig-name descname"><span class="pre">device_mod</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">IRModule</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.device_mod" title="Permalink to this definition">#</a></dt>
511511
<dd></dd></dl>
512512

513+
<dl class="py method">
514+
<dt class="sig sig-object py" id="tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.generate_l2_persistent_map">
515+
<span class="sig-name descname"><span class="pre">generate_l2_persistent_map</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.generate_l2_persistent_map" title="Permalink to this definition">#</a></dt>
516+
<dd></dd></dl>
517+
513518
<dl class="py method">
514519
<dt class="sig sig-object py" id="tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.generate_tma_descriptor_args">
515520
<span class="sig-name descname"><span class="pre">generate_tma_descriptor_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">desc_name_map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.generate_tma_descriptor_args" title="Permalink to this definition">#</a></dt>
@@ -717,6 +722,7 @@
717722
<li><a class="reference internal" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.backend"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.backend</span></code></a></li>
718723
<li><a class="reference internal" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.create_dispatch_func"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.create_dispatch_func()</span></code></a></li>
719724
<li><a class="reference internal" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.device_mod"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.device_mod</span></code></a></li>
725+
<li><a class="reference internal" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.generate_l2_persistent_map"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.generate_l2_persistent_map()</span></code></a></li>
720726
<li><a class="reference internal" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.generate_tma_descriptor_args"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.generate_tma_descriptor_args()</span></code></a></li>
721727
<li><a class="reference internal" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.get_dynamic_symbolic_set"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.get_dynamic_symbolic_set()</span></code></a></li>
722728
<li><a class="reference internal" href="#tilelang.jit.adapter.wrapper.TLCUDASourceWrapper.get_init_func"><code class="docutils literal notranslate"><span class="pre">TLCUDASourceWrapper.get_init_func()</span></code></a></li>

api/tilelang.language.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -771,6 +771,21 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
771771
<section id="module-tilelang.language">
772772
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-tilelang.language" title="Permalink to this heading">#</a></h2>
773773
<p>The language interface for tl programs.</p>
774+
<dl class="py function">
775+
<dt class="sig sig-object py" id="tilelang.language.annotate_l2_hit_ratio">
776+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.</span></span><span class="sig-name descname"><span class="pre">annotate_l2_hit_ratio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">l2_hit_ratio_map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.annotate_l2_hit_ratio" title="Permalink to this definition">#</a></dt>
777+
<dd><p>Annotate the L2 hit ratio of the buffer, detailed explanation please refer to:
778+
<a class="reference external" href="https://docs.nvidia.com/cuda/cuda-c-programming-guide/#l2-policy-for-persisting-accesses">https://docs.nvidia.com/cuda/cuda-c-programming-guide/#l2-policy-for-persisting-accesses</a></p>
779+
<dl class="field-list simple">
780+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
781+
<dd class="field-odd"><p><strong>l2_hit_ratio_map</strong> (<em>dict</em>) – a dictionary of buffer to L2 hit ratio value</p>
782+
</dd>
783+
</dl>
784+
<p class="rubric">Example</p>
785+
<p># 0.5 is the hit ratio
786+
T.annotate_l2_hit_ratio({A: 0.5})</p>
787+
</dd></dl>
788+
774789
<dl class="py function">
775790
<dt class="sig sig-object py" id="tilelang.language.annotate_layout">
776791
<span class="sig-prename descclassname"><span class="pre">tilelang.language.</span></span><span class="sig-name descname"><span class="pre">annotate_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layout_map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.annotate_layout" title="Permalink to this definition">#</a></dt>
@@ -932,6 +947,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
932947
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
933948
<li><a class="reference internal" href="#submodules">Submodules</a></li>
934949
<li><a class="reference internal" href="#module-tilelang.language">Module contents</a><ul>
950+
<li><a class="reference internal" href="#tilelang.language.annotate_l2_hit_ratio"><code class="docutils literal notranslate"><span class="pre">annotate_l2_hit_ratio()</span></code></a></li>
935951
<li><a class="reference internal" href="#tilelang.language.annotate_layout"><code class="docutils literal notranslate"><span class="pre">annotate_layout()</span></code></a></li>
936952
<li><a class="reference internal" href="#tilelang.language.annotate_padding"><code class="docutils literal notranslate"><span class="pre">annotate_padding()</span></code></a></li>
937953
<li><a class="reference internal" href="#tilelang.language.import_source"><code class="docutils literal notranslate"><span class="pre">import_source()</span></code></a></li>

0 commit comments

Comments
 (0)