Skip to content

Commit f8482b1

Browse files
Update docs
1 parent e96024a commit f8482b1

File tree

5 files changed

+86
-32
lines changed

5 files changed

+86
-32
lines changed

_sources/autoapi/tilelang/env/index.rst.txt

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Attributes
2020
tilelang.env.DEV
2121
tilelang.env.THIRD_PARTY_ROOT
2222
tilelang.env.DEV
23+
tilelang.env.env
2324
tilelang.env.enable_cache
2425
tilelang.env.disable_cache
2526
tilelang.env.is_cache_enabled
26-
tilelang.env.env
2727
tilelang.env.CUDA_HOME
2828
tilelang.env.ROCM_HOME
2929
tilelang.env.tvm_path
@@ -201,12 +201,6 @@ Module Contents
201201

202202

203203

204-
.. py:data:: enable_cache
205-
206-
.. py:data:: disable_cache
207-
208-
.. py:data:: is_cache_enabled
209-
210204
.. py:class:: Environment
211205
212206
Environment configuration for TileLang.
@@ -247,12 +241,18 @@ Module Contents
247241
.. py:attribute:: TILELANG_PRINT_ON_COMPILATION
248242
249243
244+
.. py:attribute:: TILELANG_DISABLE_CACHE
245+
246+
250247
.. py:attribute:: TILELANG_CLEAR_CACHE
251248
252249
253250
.. py:attribute:: TILELANG_USE_GEMM_V1
254251
255252
253+
.. py:attribute:: TILELANG_AUTO_TUNING_DISABLE_CACHE
254+
255+
256256
.. py:attribute:: TILELANG_AUTO_TUNING_CPU_UTILITIES
257257
258258
@@ -277,6 +277,12 @@ Module Contents
277277
.. py:method:: disable_cache()
278278
279279
280+
.. py:method:: is_cache_globally_disabled()
281+
282+
283+
.. py:method:: is_autotune_cache_disabled()
284+
285+
280286
.. py:method:: is_print_on_compilation_enabled()
281287
282288
@@ -291,6 +297,12 @@ Module Contents
291297

292298
.. py:data:: env
293299
300+
.. py:data:: enable_cache
301+
302+
.. py:data:: disable_cache
303+
304+
.. py:data:: is_cache_enabled
305+
294306
.. py:data:: CUDA_HOME
295307
296308
.. py:data:: ROCM_HOME

autoapi/tilelang/env/index.html

Lines changed: 56 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -548,16 +548,16 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
548548
<tr class="row-odd"><td><p><a class="reference internal" href="#id1" title="tilelang.env.DEV"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DEV</span></code></a></p></td>
549549
<td><p></p></td>
550550
</tr>
551-
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.env.enable_cache" title="tilelang.env.enable_cache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enable_cache</span></code></a></p></td>
551+
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.env.env" title="tilelang.env.env"><code class="xref py py-obj docutils literal notranslate"><span class="pre">env</span></code></a></p></td>
552552
<td><p></p></td>
553553
</tr>
554-
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.env.disable_cache" title="tilelang.env.disable_cache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disable_cache</span></code></a></p></td>
554+
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.env.enable_cache" title="tilelang.env.enable_cache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enable_cache</span></code></a></p></td>
555555
<td><p></p></td>
556556
</tr>
557-
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.env.is_cache_enabled" title="tilelang.env.is_cache_enabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_cache_enabled</span></code></a></p></td>
557+
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.env.disable_cache" title="tilelang.env.disable_cache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disable_cache</span></code></a></p></td>
558558
<td><p></p></td>
559559
</tr>
560-
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.env.env" title="tilelang.env.env"><code class="xref py py-obj docutils literal notranslate"><span class="pre">env</span></code></a></p></td>
560+
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.env.is_cache_enabled" title="tilelang.env.is_cache_enabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_cache_enabled</span></code></a></p></td>
561561
<td><p></p></td>
562562
</tr>
563563
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.env.CUDA_HOME" title="tilelang.env.CUDA_HOME"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CUDA_HOME</span></code></a></p></td>
@@ -805,21 +805,6 @@ <h3>Benefits<a class="headerlink" href="#benefits" title="Link to this heading">
805805
</section>
806806
</dd></dl>
807807

808-
<dl class="py data">
809-
<dt class="sig sig-object py" id="tilelang.env.enable_cache">
810-
<span class="sig-prename descclassname"><span class="pre">tilelang.env.</span></span><span class="sig-name descname"><span class="pre">enable_cache</span></span><a class="headerlink" href="#tilelang.env.enable_cache" title="Link to this definition"></a></dt>
811-
<dd></dd></dl>
812-
813-
<dl class="py data">
814-
<dt class="sig sig-object py" id="tilelang.env.disable_cache">
815-
<span class="sig-prename descclassname"><span class="pre">tilelang.env.</span></span><span class="sig-name descname"><span class="pre">disable_cache</span></span><a class="headerlink" href="#tilelang.env.disable_cache" title="Link to this definition"></a></dt>
816-
<dd></dd></dl>
817-
818-
<dl class="py data">
819-
<dt class="sig sig-object py" id="tilelang.env.is_cache_enabled">
820-
<span class="sig-prename descclassname"><span class="pre">tilelang.env.</span></span><span class="sig-name descname"><span class="pre">is_cache_enabled</span></span><a class="headerlink" href="#tilelang.env.is_cache_enabled" title="Link to this definition"></a></dt>
821-
<dd></dd></dl>
822-
823808
<dl class="py class">
824809
<dt class="sig sig-object py" id="tilelang.env.Environment">
825810
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.env.</span></span><span class="sig-name descname"><span class="pre">Environment</span></span><a class="headerlink" href="#tilelang.env.Environment" title="Link to this definition"></a></dt>
@@ -881,6 +866,11 @@ <h3>Benefits<a class="headerlink" href="#benefits" title="Link to this heading">
881866
<span class="sig-name descname"><span class="pre">TILELANG_PRINT_ON_COMPILATION</span></span><a class="headerlink" href="#tilelang.env.Environment.TILELANG_PRINT_ON_COMPILATION" title="Link to this definition"></a></dt>
882867
<dd></dd></dl>
883868

869+
<dl class="py attribute">
870+
<dt class="sig sig-object py" id="tilelang.env.Environment.TILELANG_DISABLE_CACHE">
871+
<span class="sig-name descname"><span class="pre">TILELANG_DISABLE_CACHE</span></span><a class="headerlink" href="#tilelang.env.Environment.TILELANG_DISABLE_CACHE" title="Link to this definition"></a></dt>
872+
<dd></dd></dl>
873+
884874
<dl class="py attribute">
885875
<dt class="sig sig-object py" id="tilelang.env.Environment.TILELANG_CLEAR_CACHE">
886876
<span class="sig-name descname"><span class="pre">TILELANG_CLEAR_CACHE</span></span><a class="headerlink" href="#tilelang.env.Environment.TILELANG_CLEAR_CACHE" title="Link to this definition"></a></dt>
@@ -891,6 +881,11 @@ <h3>Benefits<a class="headerlink" href="#benefits" title="Link to this heading">
891881
<span class="sig-name descname"><span class="pre">TILELANG_USE_GEMM_V1</span></span><a class="headerlink" href="#tilelang.env.Environment.TILELANG_USE_GEMM_V1" title="Link to this definition"></a></dt>
892882
<dd></dd></dl>
893883

884+
<dl class="py attribute">
885+
<dt class="sig sig-object py" id="tilelang.env.Environment.TILELANG_AUTO_TUNING_DISABLE_CACHE">
886+
<span class="sig-name descname"><span class="pre">TILELANG_AUTO_TUNING_DISABLE_CACHE</span></span><a class="headerlink" href="#tilelang.env.Environment.TILELANG_AUTO_TUNING_DISABLE_CACHE" title="Link to this definition"></a></dt>
887+
<dd></dd></dl>
888+
894889
<dl class="py attribute">
895890
<dt class="sig sig-object py" id="tilelang.env.Environment.TILELANG_AUTO_TUNING_CPU_UTILITIES">
896891
<span class="sig-name descname"><span class="pre">TILELANG_AUTO_TUNING_CPU_UTILITIES</span></span><a class="headerlink" href="#tilelang.env.Environment.TILELANG_AUTO_TUNING_CPU_UTILITIES" title="Link to this definition"></a></dt>
@@ -946,6 +941,26 @@ <h3>Benefits<a class="headerlink" href="#benefits" title="Link to this heading">
946941
</dl>
947942
</dd></dl>
948943

944+
<dl class="py method">
945+
<dt class="sig sig-object py" id="tilelang.env.Environment.is_cache_globally_disabled">
946+
<span class="sig-name descname"><span class="pre">is_cache_globally_disabled</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.env.Environment.is_cache_globally_disabled" title="Link to this definition"></a></dt>
947+
<dd><dl class="field-list simple">
948+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
949+
<dd class="field-odd"><p><a class="reference internal" href="../language/v2/dtypes/index.html#tilelang.language.v2.dtypes.bool" title="tilelang.language.v2.dtypes.bool">bool</a></p>
950+
</dd>
951+
</dl>
952+
</dd></dl>
953+
954+
<dl class="py method">
955+
<dt class="sig sig-object py" id="tilelang.env.Environment.is_autotune_cache_disabled">
956+
<span class="sig-name descname"><span class="pre">is_autotune_cache_disabled</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.env.Environment.is_autotune_cache_disabled" title="Link to this definition"></a></dt>
957+
<dd><dl class="field-list simple">
958+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
959+
<dd class="field-odd"><p><a class="reference internal" href="../language/v2/dtypes/index.html#tilelang.language.v2.dtypes.bool" title="tilelang.language.v2.dtypes.bool">bool</a></p>
960+
</dd>
961+
</dl>
962+
</dd></dl>
963+
949964
<dl class="py method">
950965
<dt class="sig sig-object py" id="tilelang.env.Environment.is_print_on_compilation_enabled">
951966
<span class="sig-name descname"><span class="pre">is_print_on_compilation_enabled</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.env.Environment.is_print_on_compilation_enabled" title="Link to this definition"></a></dt>
@@ -976,6 +991,21 @@ <h3>Benefits<a class="headerlink" href="#benefits" title="Link to this heading">
976991
<span class="sig-prename descclassname"><span class="pre">tilelang.env.</span></span><span class="sig-name descname"><span class="pre">env</span></span><a class="headerlink" href="#tilelang.env.env" title="Link to this definition"></a></dt>
977992
<dd></dd></dl>
978993

994+
<dl class="py data">
995+
<dt class="sig sig-object py" id="tilelang.env.enable_cache">
996+
<span class="sig-prename descclassname"><span class="pre">tilelang.env.</span></span><span class="sig-name descname"><span class="pre">enable_cache</span></span><a class="headerlink" href="#tilelang.env.enable_cache" title="Link to this definition"></a></dt>
997+
<dd></dd></dl>
998+
999+
<dl class="py data">
1000+
<dt class="sig sig-object py" id="tilelang.env.disable_cache">
1001+
<span class="sig-prename descclassname"><span class="pre">tilelang.env.</span></span><span class="sig-name descname"><span class="pre">disable_cache</span></span><a class="headerlink" href="#tilelang.env.disable_cache" title="Link to this definition"></a></dt>
1002+
<dd></dd></dl>
1003+
1004+
<dl class="py data">
1005+
<dt class="sig sig-object py" id="tilelang.env.is_cache_enabled">
1006+
<span class="sig-prename descclassname"><span class="pre">tilelang.env.</span></span><span class="sig-name descname"><span class="pre">is_cache_enabled</span></span><a class="headerlink" href="#tilelang.env.is_cache_enabled" title="Link to this definition"></a></dt>
1007+
<dd></dd></dl>
1008+
9791009
<dl class="py data">
9801010
<dt class="sig sig-object py" id="tilelang.env.CUDA_HOME">
9811011
<span class="sig-prename descclassname"><span class="pre">tilelang.env.</span></span><span class="sig-name descname"><span class="pre">CUDA_HOME</span></span><a class="headerlink" href="#tilelang.env.CUDA_HOME" title="Link to this definition"></a></dt>
@@ -1114,9 +1144,6 @@ <h3>Benefits<a class="headerlink" href="#benefits" title="Link to this heading">
11141144
<li><a class="reference internal" href="#tilelang.env.EnvVar.__set__"><code class="docutils literal notranslate"><span class="pre">EnvVar.__set__()</span></code></a></li>
11151145
</ul>
11161146
</li>
1117-
<li><a class="reference internal" href="#tilelang.env.enable_cache"><code class="docutils literal notranslate"><span class="pre">enable_cache</span></code></a></li>
1118-
<li><a class="reference internal" href="#tilelang.env.disable_cache"><code class="docutils literal notranslate"><span class="pre">disable_cache</span></code></a></li>
1119-
<li><a class="reference internal" href="#tilelang.env.is_cache_enabled"><code class="docutils literal notranslate"><span class="pre">is_cache_enabled</span></code></a></li>
11201147
<li><a class="reference internal" href="#tilelang.env.Environment"><code class="docutils literal notranslate"><span class="pre">Environment</span></code></a><ul>
11211148
<li><a class="reference internal" href="#tilelang.env.Environment.CUDA_HOME"><code class="docutils literal notranslate"><span class="pre">Environment.CUDA_HOME</span></code></a></li>
11221149
<li><a class="reference internal" href="#tilelang.env.Environment.ROCM_HOME"><code class="docutils literal notranslate"><span class="pre">Environment.ROCM_HOME</span></code></a></li>
@@ -1129,8 +1156,10 @@ <h3>Benefits<a class="headerlink" href="#benefits" title="Link to this heading">
11291156
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_CACHE_DIR"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_CACHE_DIR</span></code></a></li>
11301157
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_TMP_DIR"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_TMP_DIR</span></code></a></li>
11311158
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_PRINT_ON_COMPILATION"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_PRINT_ON_COMPILATION</span></code></a></li>
1159+
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_DISABLE_CACHE"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_DISABLE_CACHE</span></code></a></li>
11321160
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_CLEAR_CACHE"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_CLEAR_CACHE</span></code></a></li>
11331161
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_USE_GEMM_V1"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_USE_GEMM_V1</span></code></a></li>
1162+
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_AUTO_TUNING_DISABLE_CACHE"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_AUTO_TUNING_DISABLE_CACHE</span></code></a></li>
11341163
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_AUTO_TUNING_CPU_UTILITIES"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_AUTO_TUNING_CPU_UTILITIES</span></code></a></li>
11351164
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_AUTO_TUNING_CPU_COUNTS"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_AUTO_TUNING_CPU_COUNTS</span></code></a></li>
11361165
<li><a class="reference internal" href="#tilelang.env.Environment.TILELANG_AUTO_TUNING_MAX_CPU_COUNT"><code class="docutils literal notranslate"><span class="pre">Environment.TILELANG_AUTO_TUNING_MAX_CPU_COUNT</span></code></a></li>
@@ -1139,11 +1168,16 @@ <h3>Benefits<a class="headerlink" href="#benefits" title="Link to this heading">
11391168
<li><a class="reference internal" href="#tilelang.env.Environment.is_cache_enabled"><code class="docutils literal notranslate"><span class="pre">Environment.is_cache_enabled()</span></code></a></li>
11401169
<li><a class="reference internal" href="#tilelang.env.Environment.enable_cache"><code class="docutils literal notranslate"><span class="pre">Environment.enable_cache()</span></code></a></li>
11411170
<li><a class="reference internal" href="#tilelang.env.Environment.disable_cache"><code class="docutils literal notranslate"><span class="pre">Environment.disable_cache()</span></code></a></li>
1171+
<li><a class="reference internal" href="#tilelang.env.Environment.is_cache_globally_disabled"><code class="docutils literal notranslate"><span class="pre">Environment.is_cache_globally_disabled()</span></code></a></li>
1172+
<li><a class="reference internal" href="#tilelang.env.Environment.is_autotune_cache_disabled"><code class="docutils literal notranslate"><span class="pre">Environment.is_autotune_cache_disabled()</span></code></a></li>
11421173
<li><a class="reference internal" href="#tilelang.env.Environment.is_print_on_compilation_enabled"><code class="docutils literal notranslate"><span class="pre">Environment.is_print_on_compilation_enabled()</span></code></a></li>
11431174
<li><a class="reference internal" href="#tilelang.env.Environment.use_gemm_v1"><code class="docutils literal notranslate"><span class="pre">Environment.use_gemm_v1()</span></code></a></li>
11441175
</ul>
11451176
</li>
11461177
<li><a class="reference internal" href="#tilelang.env.env"><code class="docutils literal notranslate"><span class="pre">env</span></code></a></li>
1178+
<li><a class="reference internal" href="#tilelang.env.enable_cache"><code class="docutils literal notranslate"><span class="pre">enable_cache</span></code></a></li>
1179+
<li><a class="reference internal" href="#tilelang.env.disable_cache"><code class="docutils literal notranslate"><span class="pre">disable_cache</span></code></a></li>
1180+
<li><a class="reference internal" href="#tilelang.env.is_cache_enabled"><code class="docutils literal notranslate"><span class="pre">is_cache_enabled</span></code></a></li>
11471181
<li><a class="reference internal" href="#tilelang.env.CUDA_HOME"><code class="docutils literal notranslate"><span class="pre">CUDA_HOME</span></code></a></li>
11481182
<li><a class="reference internal" href="#tilelang.env.ROCM_HOME"><code class="docutils literal notranslate"><span class="pre">ROCM_HOME</span></code></a></li>
11491183
<li><a class="reference internal" href="#tilelang.env.prepend_pythonpath"><code class="docutils literal notranslate"><span class="pre">prepend_pythonpath()</span></code></a></li>

0 commit comments

Comments
 (0)