Skip to content

Commit 06ab6ff

Browse files
committed
Update docs
1 parent 87bd72d commit 06ab6ff

8 files changed

+71
-9
lines changed

api/tilelang.cache.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,8 +409,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
409409
<ul>
410410
<li class="toctree-l1"><a class="reference internal" href="tilelang.cache.kernel_cache.html">tilelang.cache.kernel_cache module</a><ul>
411411
<li class="toctree-l2"><a class="reference internal" href="tilelang.cache.kernel_cache.html#tilelang.cache.kernel_cache.KernelCache"><code class="docutils literal notranslate"><span class="pre">KernelCache</span></code></a><ul>
412+
<li class="toctree-l3"><a class="reference internal" href="tilelang.cache.kernel_cache.html#tilelang.cache.kernel_cache.KernelCache.cache_dir"><code class="docutils literal notranslate"><span class="pre">KernelCache.cache_dir</span></code></a></li>
412413
<li class="toctree-l3"><a class="reference internal" href="tilelang.cache.kernel_cache.html#tilelang.cache.kernel_cache.KernelCache.cached"><code class="docutils literal notranslate"><span class="pre">KernelCache.cached()</span></code></a></li>
413414
<li class="toctree-l3"><a class="reference internal" href="tilelang.cache.kernel_cache.html#tilelang.cache.kernel_cache.KernelCache.clear_cache"><code class="docutils literal notranslate"><span class="pre">KernelCache.clear_cache()</span></code></a></li>
415+
<li class="toctree-l3"><a class="reference internal" href="tilelang.cache.kernel_cache.html#tilelang.cache.kernel_cache.KernelCache.get_cache_dir"><code class="docutils literal notranslate"><span class="pre">KernelCache.get_cache_dir()</span></code></a></li>
416+
<li class="toctree-l3"><a class="reference internal" href="tilelang.cache.kernel_cache.html#tilelang.cache.kernel_cache.KernelCache.set_cache_dir"><code class="docutils literal notranslate"><span class="pre">KernelCache.set_cache_dir()</span></code></a></li>
414417
</ul>
415418
</li>
416419
</ul>
@@ -433,6 +436,27 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
433436
<dd><p>Clears the entire kernel cache (using KernelCache class).</p>
434437
</dd></dl>
435438

439+
<dl class="py function">
440+
<dt class="sig sig-object py" id="tilelang.cache.get_cache_dir">
441+
<span class="sig-prename descclassname"><span class="pre">tilelang.cache.</span></span><span class="sig-name descname"><span class="pre">get_cache_dir</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Path</span></span></span><a class="headerlink" href="#tilelang.cache.get_cache_dir" title="Permalink to this definition">#</a></dt>
442+
<dd><p>Gets the cache directory for the kernel cache.
443+
.. rubric:: Example</p>
444+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">tilelang</span><span class="o">.</span><span class="n">cache</span><span class="o">.</span><span class="n">get_cache_dir</span><span class="p">()</span>
445+
<span class="go">PosixPath(&#39;/Users/username/.tilelang/cache&#39;)</span>
446+
</pre></div>
447+
</div>
448+
</dd></dl>
449+
450+
<dl class="py function">
451+
<dt class="sig sig-object py" id="tilelang.cache.set_cache_dir">
452+
<span class="sig-prename descclassname"><span class="pre">tilelang.cache.</span></span><span class="sig-name descname"><span class="pre">set_cache_dir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cache_dir</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><a class="headerlink" href="#tilelang.cache.set_cache_dir" title="Permalink to this definition">#</a></dt>
453+
<dd><p>Sets the cache directory for the kernel cache.
454+
.. rubric:: Example</p>
455+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">tilelang</span><span class="o">.</span><span class="n">cache</span><span class="o">.</span><span class="n">set_cache_dir</span><span class="p">(</span><span class="s2">&quot;/path/to/cache&quot;</span><span class="p">)</span>
456+
</pre></div>
457+
</div>
458+
</dd></dl>
459+
436460
</section>
437461
</section>
438462

@@ -496,6 +520,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
496520
<li><a class="reference internal" href="#module-tilelang.cache">Module contents</a><ul>
497521
<li><a class="reference internal" href="#tilelang.cache.cached"><code class="docutils literal notranslate"><span class="pre">cached()</span></code></a></li>
498522
<li><a class="reference internal" href="#tilelang.cache.clear_cache"><code class="docutils literal notranslate"><span class="pre">clear_cache()</span></code></a></li>
523+
<li><a class="reference internal" href="#tilelang.cache.get_cache_dir"><code class="docutils literal notranslate"><span class="pre">get_cache_dir()</span></code></a></li>
524+
<li><a class="reference internal" href="#tilelang.cache.set_cache_dir"><code class="docutils literal notranslate"><span class="pre">set_cache_dir()</span></code></a></li>
499525
</ul>
500526
</li>
501527
</ul>

api/tilelang.cache.kernel_cache.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,11 @@
416416
kernel_lib.so: The compiled kernel library
417417
params.pkl: The compiled kernel parameters</p>
418418
</div></blockquote>
419+
<dl class="py attribute">
420+
<dt class="sig sig-object py" id="tilelang.cache.kernel_cache.KernelCache.cache_dir">
421+
<span class="sig-name descname"><span class="pre">cache_dir</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('/home/t-leiwang/.tilelang/cache')</span></em><a class="headerlink" href="#tilelang.cache.kernel_cache.KernelCache.cache_dir" title="Permalink to this definition">#</a></dt>
422+
<dd></dd></dl>
423+
419424
<dl class="py method">
420425
<dt class="sig sig-object py" id="tilelang.cache.kernel_cache.KernelCache.cached">
421426
<span class="sig-name descname"><span class="pre">cached</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">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><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="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</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">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">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><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.cache.kernel_cache.KernelCache.cached" title="Permalink to this definition">#</a></dt>
@@ -445,6 +450,18 @@
445450
<dd><p>Clears the entire kernel cache, including both in-memory and disk cache.</p>
446451
</dd></dl>
447452

453+
<dl class="py method">
454+
<dt class="sig sig-object py" id="tilelang.cache.kernel_cache.KernelCache.get_cache_dir">
455+
<span class="sig-name descname"><span class="pre">get_cache_dir</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Path</span></span></span><a class="headerlink" href="#tilelang.cache.kernel_cache.KernelCache.get_cache_dir" title="Permalink to this definition">#</a></dt>
456+
<dd><p>Gets the cache directory for the kernel cache.</p>
457+
</dd></dl>
458+
459+
<dl class="py method">
460+
<dt class="sig sig-object py" id="tilelang.cache.kernel_cache.KernelCache.set_cache_dir">
461+
<span class="sig-name descname"><span class="pre">set_cache_dir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cache_dir</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><a class="headerlink" href="#tilelang.cache.kernel_cache.KernelCache.set_cache_dir" title="Permalink to this definition">#</a></dt>
462+
<dd><p>Sets the cache directory for the kernel cache.</p>
463+
</dd></dl>
464+
448465
</dd></dl>
449466

450467
</section>
@@ -506,8 +523,11 @@
506523
<ul>
507524
<li><a class="reference internal" href="#">tilelang.cache.kernel_cache module</a><ul>
508525
<li><a class="reference internal" href="#tilelang.cache.kernel_cache.KernelCache"><code class="docutils literal notranslate"><span class="pre">KernelCache</span></code></a><ul>
526+
<li><a class="reference internal" href="#tilelang.cache.kernel_cache.KernelCache.cache_dir"><code class="docutils literal notranslate"><span class="pre">KernelCache.cache_dir</span></code></a></li>
509527
<li><a class="reference internal" href="#tilelang.cache.kernel_cache.KernelCache.cached"><code class="docutils literal notranslate"><span class="pre">KernelCache.cached()</span></code></a></li>
510528
<li><a class="reference internal" href="#tilelang.cache.kernel_cache.KernelCache.clear_cache"><code class="docutils literal notranslate"><span class="pre">KernelCache.clear_cache()</span></code></a></li>
529+
<li><a class="reference internal" href="#tilelang.cache.kernel_cache.KernelCache.get_cache_dir"><code class="docutils literal notranslate"><span class="pre">KernelCache.get_cache_dir()</span></code></a></li>
530+
<li><a class="reference internal" href="#tilelang.cache.kernel_cache.KernelCache.set_cache_dir"><code class="docutils literal notranslate"><span class="pre">KernelCache.set_cache_dir()</span></code></a></li>
511531
</ul>
512532
</li>
513533
</ul>

api/tilelang.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,8 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
501501
<li class="toctree-l2"><a class="reference internal" href="tilelang.cache.html#module-tilelang.cache">Module contents</a><ul>
502502
<li class="toctree-l3"><a class="reference internal" href="tilelang.cache.html#tilelang.cache.cached"><code class="docutils literal notranslate"><span class="pre">cached()</span></code></a></li>
503503
<li class="toctree-l3"><a class="reference internal" href="tilelang.cache.html#tilelang.cache.clear_cache"><code class="docutils literal notranslate"><span class="pre">clear_cache()</span></code></a></li>
504+
<li class="toctree-l3"><a class="reference internal" href="tilelang.cache.html#tilelang.cache.get_cache_dir"><code class="docutils literal notranslate"><span class="pre">get_cache_dir()</span></code></a></li>
505+
<li class="toctree-l3"><a class="reference internal" href="tilelang.cache.html#tilelang.cache.set_cache_dir"><code class="docutils literal notranslate"><span class="pre">set_cache_dir()</span></code></a></li>
504506
</ul>
505507
</li>
506508
</ul>

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">0x7f0bb4ecb250&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">0x7f138cbb8790&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">0x7f0bb4ecb250&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">0x7f138cbb8790&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)