Skip to content

Commit e479e07

Browse files
committed
Update docs
1 parent 2fe54e3 commit e479e07

File tree

7 files changed

+45
-3
lines changed

7 files changed

+45
-3
lines changed

api/tilelang.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -977,6 +977,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
977977
<li class="toctree-l2"><a class="reference internal" href="tilelang.transform.html#module-tilelang.transform">Module contents</a><ul>
978978
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.AnnotateDeviceRegions"><code class="docutils literal notranslate"><span class="pre">AnnotateDeviceRegions()</span></code></a></li>
979979
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.ClusterPlanning"><code class="docutils literal notranslate"><span class="pre">ClusterPlanning()</span></code></a></li>
980+
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.ConfigIndexBitwidth"><code class="docutils literal notranslate"><span class="pre">ConfigIndexBitwidth()</span></code></a></li>
980981
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.FrontendLegalize"><code class="docutils literal notranslate"><span class="pre">FrontendLegalize()</span></code></a></li>
981982
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.IfStmtBinding"><code class="docutils literal notranslate"><span class="pre">IfStmtBinding()</span></code></a></li>
982983
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.InjectFenceProxy"><code class="docutils literal notranslate"><span class="pre">InjectFenceProxy()</span></code></a></li>

api/tilelang.jit.html

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,30 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
495495
<dl class="py function">
496496
<dt class="sig sig-object py" id="tilelang.jit.compile">
497497
<span class="sig-prename descclassname"><span class="pre">tilelang.jit.</span></span><span class="sig-name descname"><span class="pre">compile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">PrimFunc</span><span class="p"><span class="pre">]</span></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">out_idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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">execution_backend</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'dlpack'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'ctypes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'cython'</span></span><span class="p"><span class="pre">]</span></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">'cython'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Target</span><span class="p"><span class="pre">]</span></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">'auto'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</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">Target</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pass_configs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><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 class="p"><span class="pre">]</span></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">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="tilelang.jit.kernel.html#tilelang.jit.kernel.JITKernel" title="tilelang.jit.kernel.JITKernel"><span class="pre">JITKernel</span></a></span></span><a class="headerlink" href="#tilelang.jit.compile" title="Permalink to this definition">#</a></dt>
498-
<dd><p>Compile the given TileLang PrimFunc with TVM and build a JITKernel.</p>
498+
<dd><p>Compile the given TileLang PrimFunc with TVM and build a JITKernel.
499+
:param func: The TileLang TIR function to compile and wrap.
500+
:type func: tvm.tir.PrimFunc, optional
501+
:param out_idx: Index(es) of the output tensors to return (default: None).
502+
:type out_idx: Union[List[int], int], optional
503+
:param execution_backend: Execution backend to use for kernel execution (default: “dlpack”).
504+
:type execution_backend: Literal[“dlpack”, “ctypes”], optional
505+
:param target: Compilation target, either as a string or a TVM Target object (default: “auto”).
506+
:type target: Union[str, Target], optional
507+
:param target_host: Target host for cross-compilation (default: None).
508+
:type target_host: Union[str, Target], optional
509+
:param verbose: Whether to enable verbose output (default: False).
510+
:type verbose: bool, optional
511+
:param pass_configs: Additional keyword arguments to pass to the Compiler PassContext.</p>
512+
<blockquote>
513+
<div><dl class="simple">
514+
<dt>Available options:</dt><dd><p>“tir.disable_vectorize”: bool, default: False
515+
“tl.disable_tma_lower”: bool, default: False
516+
“tl.config_index_bitwidth”: int, default: None</p>
517+
</dd>
518+
</dl>
519+
</div></blockquote>
520+
<dl class="field-list simple">
521+
</dl>
499522
</dd></dl>
500523

501524
<dl class="py function">

api/tilelang.language.proxy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@
450450
<p>Buffer proxy class for constructing tir buffer.</p>
451451
<dl class="py method">
452452
<dt class="sig sig-object py" id="tilelang.language.proxy.BufferProxy.from_ptr">
453-
<span class="sig-name descname"><span class="pre">from_ptr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pointer_var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">tvm.ir.expr.PrimExpr</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</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">'float32'</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">&lt;tilelang.language.proxy.BufferProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7fd5a5a2ffd0&gt;</span></span></span><a class="headerlink" href="#tilelang.language.proxy.BufferProxy.from_ptr" title="Permalink to this definition">#</a></dt>
453+
<span class="sig-name descname"><span class="pre">from_ptr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pointer_var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">tvm.ir.expr.PrimExpr</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</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">'float32'</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">&lt;tilelang.language.proxy.BufferProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f2fa2d47880&gt;</span></span></span><a class="headerlink" href="#tilelang.language.proxy.BufferProxy.from_ptr" title="Permalink to this definition">#</a></dt>
454454
<dd><p>Create a buffer from a pointer, shape, and data type.</p>
455455
<dl class="field-list simple">
456456
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

api/tilelang.transform.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,21 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
441441
</dl>
442442
</dd></dl>
443443

444+
<dl class="py function">
445+
<dt class="sig sig-object py" id="tilelang.transform.ConfigIndexBitwidth">
446+
<span class="sig-prename descclassname"><span class="pre">tilelang.transform.</span></span><span class="sig-name descname"><span class="pre">ConfigIndexBitwidth</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.transform.ConfigIndexBitwidth" title="Permalink to this definition">#</a></dt>
447+
<dd><p>Config index bitwidth.</p>
448+
<dl class="field-list simple">
449+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
450+
<dd class="field-odd"><p><ul class="simple">
451+
<li><p><strong>fpass</strong> (<em>tvm.transform.Pass</em>) – The result pass</p></li>
452+
<li><p><em>—-</em></p></li>
453+
</ul>
454+
</p>
455+
</dd>
456+
</dl>
457+
</dd></dl>
458+
444459
<dl class="py function">
445460
<dt class="sig sig-object py" id="tilelang.transform.FrontendLegalize">
446461
<span class="sig-prename descclassname"><span class="pre">tilelang.transform.</span></span><span class="sig-name descname"><span class="pre">FrontendLegalize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.transform.FrontendLegalize" title="Permalink to this definition">#</a></dt>
@@ -811,6 +826,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
811826
<li><a class="reference internal" href="#module-tilelang.transform">Module contents</a><ul>
812827
<li><a class="reference internal" href="#tilelang.transform.AnnotateDeviceRegions"><code class="docutils literal notranslate"><span class="pre">AnnotateDeviceRegions()</span></code></a></li>
813828
<li><a class="reference internal" href="#tilelang.transform.ClusterPlanning"><code class="docutils literal notranslate"><span class="pre">ClusterPlanning()</span></code></a></li>
829+
<li><a class="reference internal" href="#tilelang.transform.ConfigIndexBitwidth"><code class="docutils literal notranslate"><span class="pre">ConfigIndexBitwidth()</span></code></a></li>
814830
<li><a class="reference internal" href="#tilelang.transform.FrontendLegalize"><code class="docutils literal notranslate"><span class="pre">FrontendLegalize()</span></code></a></li>
815831
<li><a class="reference internal" href="#tilelang.transform.IfStmtBinding"><code class="docutils literal notranslate"><span class="pre">IfStmtBinding()</span></code></a></li>
816832
<li><a class="reference internal" href="#tilelang.transform.InjectFenceProxy"><code class="docutils literal notranslate"><span class="pre">InjectFenceProxy()</span></code></a></li>

genindex.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -766,6 +766,8 @@ <h2>C</h2>
766766
<li><a href="api/tilelang.layout.fragment.html#tilelang.layout.fragment.Fragment.condense_rep_var">condense_rep_var() (tilelang.layout.fragment.Fragment method)</a>
767767
</li>
768768
<li><a href="api/tilelang.autotuner.html#id0">config (tilelang.autotuner.AutotuneResult attribute)</a>, <a href="api/tilelang.autotuner.html#tilelang.autotuner.AutotuneResult.config">[1]</a>
769+
</li>
770+
<li><a href="api/tilelang.transform.html#tilelang.transform.ConfigIndexBitwidth">ConfigIndexBitwidth() (in module tilelang.transform)</a>
769771
</li>
770772
<li><a href="api/tilelang.carver.roller.shape_inference.tir.html#tilelang.carver.roller.shape_inference.tir.InputShapeInference.construct_dependency_target">construct_dependency_target() (tilelang.carver.roller.shape_inference.tir.InputShapeInference method)</a>
771773
</li>

objects.inv

16 Bytes
Binary file not shown.

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)