Skip to content

Commit ae9335a

Browse files
Update docs
1 parent 5a8df25 commit ae9335a

File tree

4 files changed

+14
-11
lines changed

4 files changed

+14
-11
lines changed

_sources/get_started/Installation.md.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,14 +93,16 @@ Some useful CMake options you can toggle while configuring:
9393

9494
(using-existing-tvm)=
9595

96-
### Building with Existing TVM Installation
96+
### Building with Customized TVM Path
9797

98-
If you already have a compatible TVM installation, use the `TVM_ROOT` environment variable to specify the location of your existing TVM repository when building tilelang:
98+
If you already have a TVM codebase, use the `TVM_ROOT` environment variable to specify the location of your existing TVM repository when building tilelang:
9999

100100
```bash
101101
TVM_ROOT=<your-tvm-repo> pip install . -v
102102
```
103103

104+
> **Note**: This will still rebuild the TVM-related libraries (stored in `TL_LIBS`). And this method often leads to some path issues. Check `env.py` to see some environment variables which are not set properly.
105+
104106
(install-using-docker)=
105107

106108
## Install Using Docker
@@ -197,8 +199,7 @@ Set `NO_TOOLCHAIN_VERSION=ON` to disable this.
197199

198200
### Run-time environment variables
199201

200-
<!-- TODO: tvm -->
201-
TODO
202+
Please refer to the `env.py` file for a full list of supported run-time environment variables.
202203

203204
## Other Tips
204205

get_started/Installation.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -575,12 +575,15 @@ <h2>Building from Source<a class="headerlink" href="#building-from-source" title
575575
<li><p><code class="docutils literal notranslate"><span class="pre">-DNO_VERSION_LABEL=ON</span></code> disables the backend/git suffix in <code class="docutils literal notranslate"><span class="pre">tilelang.__version__</span></code>.</p></li>
576576
</ul>
577577
</section>
578-
<section id="building-with-existing-tvm-installation">
579-
<span id="using-existing-tvm"></span><h3>Building with Existing TVM Installation<a class="headerlink" href="#building-with-existing-tvm-installation" title="Link to this heading"></a></h3>
580-
<p>If you already have a compatible TVM installation, use the <code class="docutils literal notranslate"><span class="pre">TVM_ROOT</span></code> environment variable to specify the location of your existing TVM repository when building tilelang:</p>
578+
<section id="building-with-customized-tvm-path">
579+
<span id="using-existing-tvm"></span><h3>Building with Customized TVM Path<a class="headerlink" href="#building-with-customized-tvm-path" title="Link to this heading"></a></h3>
580+
<p>If you already have a TVM codebase, use the <code class="docutils literal notranslate"><span class="pre">TVM_ROOT</span></code> environment variable to specify the location of your existing TVM repository when building tilelang:</p>
581581
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">TVM_ROOT</span><span class="o">=</span>&lt;your-tvm-repo&gt;<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>.<span class="w"> </span>-v
582582
</pre></div>
583583
</div>
584+
<blockquote>
585+
<div><p><strong>Note</strong>: This will still rebuild the TVM-related libraries (stored in <code class="docutils literal notranslate"><span class="pre">TL_LIBS</span></code>). And this method often leads to some path issues. Check <code class="docutils literal notranslate"><span class="pre">env.py</span></code> to see some environment variables which are not set properly.</p>
586+
</div></blockquote>
584587
</section>
585588
</section>
586589
<section id="install-using-docker">
@@ -674,8 +677,7 @@ <h3>Build-time environment variables<a class="headerlink" href="#build-time-envi
674677
</section>
675678
<section id="run-time-environment-variables">
676679
<h3>Run-time environment variables<a class="headerlink" href="#run-time-environment-variables" title="Link to this heading"></a></h3>
677-
<!-- TODO: tvm -->
678-
<p>TODO</p>
680+
<p>Please refer to the <code class="docutils literal notranslate"><span class="pre">env.py</span></code> file for a full list of supported run-time environment variables.</p>
679681
</section>
680682
</section>
681683
<section id="other-tips">
@@ -775,7 +777,7 @@ <h3>Repairing Wheels<a class="headerlink" href="#repairing-wheels" title="Link t
775777
<li><a class="reference internal" href="#installing-with-pip">Installing with pip</a></li>
776778
<li><a class="reference internal" href="#building-from-source">Building from Source</a><ul>
777779
<li><a class="reference internal" href="#working-from-source-via-pythonpath">Working from Source via <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code></a></li>
778-
<li><a class="reference internal" href="#building-with-existing-tvm-installation">Building with Existing TVM Installation</a></li>
780+
<li><a class="reference internal" href="#building-with-customized-tvm-path">Building with Customized TVM Path</a></li>
779781
</ul>
780782
</li>
781783
<li><a class="reference internal" href="#install-using-docker">Install Using Docker</a></li>

objects.inv

2 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)