Skip to content

Commit fb625e1

Browse files
Update docs
1 parent f7c0585 commit fb625e1

File tree

4 files changed

+43
-6
lines changed

4 files changed

+43
-6
lines changed

_sources/get_started/Installation.md.txt

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,9 +208,6 @@ pip install tilelang -f https://tile-ai.github.io/whl/nightly/cu121/
208208

209209
## Install Configs
210210

211-
tilelang use ffi/cython/dlpack to interact with pytorch tensor,
212-
so `--no-build-isolation` and similar configs are not necessary.
213-
214211
### Build-time environment variables
215212
`USE_CUDA`: If to enable CUDA support, default: `ON` on Linux, set to `OFF` to build a CPU version. By default, we'll use `/usr/local/cuda` for building tilelang. Set `CUDAToolkit_ROOT` to use different cuda toolkit.
216213

@@ -251,3 +248,25 @@ VSCode with clangd and [clangd extension](https://marketplace.visualstudio.com/i
251248
If you plan to use your wheel in other environment,
252249
it's recommend to use auditwheel (on Linux) or delocate (on Darwin)
253250
to repair them.
251+
252+
## Faster rebuild for developers
253+
254+
`pip install` introduces extra [un]packaging and takes ~30 sec to complete,
255+
even if no source change.
256+
257+
Developers who needs to recompile frequently could use:
258+
259+
```bash
260+
pip install -r requirements-dev.txt
261+
pip install -e . -v --no-build-isolation
262+
263+
cd build; ninja
264+
```
265+
266+
When running in editable/developer mode,
267+
you'll see logs like below:
268+
269+
```console
270+
$ python -c 'import tilelang'
271+
2025-10-14 11:11:29 [TileLang:tilelang.env:WARNING]: Loading tilelang libs from dev root: /Users/yyc/repo/tilelang/build
272+
```

get_started/Installation.html

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -658,8 +658,6 @@ <h2>Install with Nightly Version<a class="headerlink" href="#install-with-nightl
658658
</section>
659659
<section id="install-configs">
660660
<h2>Install Configs<a class="headerlink" href="#install-configs" title="Link to this heading"></a></h2>
661-
<p>tilelang use ffi/cython/dlpack to interact with pytorch tensor,
662-
so <code class="docutils literal notranslate"><span class="pre">--no-build-isolation</span></code> and similar configs are not necessary.</p>
663661
<section id="build-time-environment-variables">
664662
<h3>Build-time environment variables<a class="headerlink" href="#build-time-environment-variables" title="Link to this heading"></a></h3>
665663
<p><code class="docutils literal notranslate"><span class="pre">USE_CUDA</span></code>: If to enable CUDA support, default: <code class="docutils literal notranslate"><span class="pre">ON</span></code> on Linux, set to <code class="docutils literal notranslate"><span class="pre">OFF</span></code> to build a CPU version. By default, we’ll use <code class="docutils literal notranslate"><span class="pre">/usr/local/cuda</span></code> for building tilelang. Set <code class="docutils literal notranslate"><span class="pre">CUDAToolkit_ROOT</span></code> to use different cuda toolkit.</p>
@@ -698,6 +696,24 @@ <h2>Repairing wheels<a class="headerlink" href="#repairing-wheels" title="Link t
698696
it’s recommend to use auditwheel (on Linux) or delocate (on Darwin)
699697
to repair them.</p>
700698
</section>
699+
<section id="faster-rebuild-for-developers">
700+
<h2>Faster rebuild for developers<a class="headerlink" href="#faster-rebuild-for-developers" title="Link to this heading"></a></h2>
701+
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> introduces extra [un]packaging and takes ~30 sec to complete,
702+
even if no source change.</p>
703+
<p>Developers who needs to recompile frequently could use:</p>
704+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-dev.txt
705+
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.<span class="w"> </span>-v<span class="w"> </span>--no-build-isolation
706+
707+
<span class="nb">cd</span><span class="w"> </span>build<span class="p">;</span><span class="w"> </span>ninja
708+
</pre></div>
709+
</div>
710+
<p>When running in editable/developer mode,
711+
you’ll see logs like below:</p>
712+
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python<span class="w"> </span>-c<span class="w"> </span><span class="s1">&#39;import tilelang&#39;</span>
713+
<span class="go">2025-10-14 11:11:29 [TileLang:tilelang.env:WARNING]: Loading tilelang libs from dev root: /Users/yyc/repo/tilelang/build</span>
714+
</pre></div>
715+
</div>
716+
</section>
701717
</section>
702718

703719
</article>
@@ -772,6 +788,7 @@ <h2>Repairing wheels<a class="headerlink" href="#repairing-wheels" title="Link t
772788
<li><a class="reference internal" href="#ide-configs">IDE Configs</a></li>
773789
<li><a class="reference internal" href="#compile-cache">Compile cache</a></li>
774790
<li><a class="reference internal" href="#repairing-wheels">Repairing wheels</a></li>
791+
<li><a class="reference internal" href="#faster-rebuild-for-developers">Faster rebuild for developers</a></li>
775792
</ul>
776793
</li>
777794
</ul>

index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,7 @@ <h1>👋 Welcome to Tile Language<a class="headerlink" href="#welcome-to-tile-la
495495
<li class="toctree-l2"><a class="reference internal" href="get_started/Installation.html#ide-configs">IDE Configs</a></li>
496496
<li class="toctree-l2"><a class="reference internal" href="get_started/Installation.html#compile-cache">Compile cache</a></li>
497497
<li class="toctree-l2"><a class="reference internal" href="get_started/Installation.html#repairing-wheels">Repairing wheels</a></li>
498+
<li class="toctree-l2"><a class="reference internal" href="get_started/Installation.html#faster-rebuild-for-developers">Faster rebuild for developers</a></li>
498499
</ul>
499500
</li>
500501
<li class="toctree-l1"><a class="reference internal" href="get_started/overview.html">The Tile Language: A Brief Introduction</a><ul>

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)