Skip to content

Commit 22cd03d

Browse files
author
GitHub Actions
committed
Update docs
1 parent fc4ec1b commit 22cd03d

File tree

4 files changed

+44
-19
lines changed

4 files changed

+44
-19
lines changed

_sources/get_started/Installation.md.txt

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@
88
- **Python Version**: >= 3.8
99
- **CUDA Version**: >= 11.0
1010

11-
The easiest way to install TileLang is directly from PyPI using pip. To install the latest version, run the following command in your terminal:
11+
The easiest way to install **tile-lang** is directly from PyPI using pip. To install the latest version, run the following command in your terminal:
1212

1313
```bash
1414
pip install tilelang
1515
```
1616

17-
Alternatively, you may choose to install TileLang using prebuilt packages available on the Release Page:
17+
Alternatively, you may choose to install **tile-lang** using prebuilt packages available on the Release Page:
1818

1919
```bash
2020
pip install tilelang-0.0.0.dev0+ubuntu.20.4.cu120-py3-none-any.whl
2121
```
2222

23-
To install the latest version of TileLang from the GitHub repository, you can run the following command:
23+
To install the latest version of **tile-lang** from the GitHub repository, you can run the following command:
2424

2525
```bash
2626
pip install git+https://github.com/tile-ai/tilelang.git
2727
```
2828

29-
After installing TileLang, you can verify the installation by running:
29+
After installing **tile-lang**, you can verify the installation by running:
3030

3131
```bash
3232
python -c "import tilelang; print(tilelang.__version__)"
@@ -40,34 +40,34 @@ python -c "import tilelang; print(tilelang.__version__)"
4040
- **Python Version**: >= 3.7
4141
- **CUDA Version**: >= 10.0
4242

43-
We recommend using a Docker container with the necessary dependencies to build TileLang from source. You can use the following command to run a Docker container with the required dependencies:
43+
We recommend using a Docker container with the necessary dependencies to build **tile-lang** from source. You can use the following command to run a Docker container with the required dependencies:
4444

4545
```bash
4646
docker run --gpus all -it --rm --ipc=host nvcr.io/nvidia/pytorch:23.01-py3
4747
```
4848

49-
To build and install TileLang directly from source, follow these steps. This process requires certain pre-requisites from Apache TVM, which can be installed on Ubuntu/Debian-based systems using the following commands:
49+
To build and install **tile-lang** directly from source, follow these steps. This process requires certain pre-requisites from Apache TVM, which can be installed on Ubuntu/Debian-based systems using the following commands:
5050

5151
```bash
5252
sudo apt-get update
5353
sudo apt-get install -y python3 python3-dev python3-setuptools gcc libtinfo-dev zlib1g-dev build-essential cmake libedit-dev libxml2-dev
5454
```
5555

56-
After installing the prerequisites, you can clone the TileLang repository and install it using pip:
56+
After installing the prerequisites, you can clone the **tile-lang** repository and install it using pip:
5757

5858
```bash
5959
git clone --recursive https://github.com/tile-ai/tilelang.git
6060
cd tileLang
6161
pip install . # Please be patient, this may take some time.
6262
```
6363

64-
If you want to install TileLang in development mode, you can run the following command:
64+
If you want to install **tile-lang** in development mode, you can run the following command:
6565

6666
```bash
6767
pip install -e .
6868
```
6969

70-
We currently provide three methods to install **TileLang**:
70+
We currently provide three methods to install **tile-lang**:
7171

7272
1. [Install from Source (using your own TVM installation)](#install-method-1)
7373
2. [Install from Source (using the bundled TVM submodule)](#install-method-2)
@@ -167,3 +167,15 @@ cd tilelang
167167
```bash
168168
bash install_cuda.sh
169169
# or bash `install_amd.sh` if you want to enable ROCm runtime
170+
```
171+
172+
## Install with Nightly Version
173+
174+
For users who want access to the latest features and improvements before official releases, we provide nightly builds of **tile-lang**.
175+
176+
```bash
177+
pip install tilelang -f https://tile-ai.github.io/whl/nightly/cu121/
178+
# or pip install tilelang --find-links https://tile-ai.github.io/whl/nightly/cu121/
179+
```
180+
181+
> **Note:** Nightly builds contain the most recent code changes but may be less stable than official releases. They're ideal for testing new features or if you need a specific bugfix that hasn't been released yet.

get_started/Installation.html

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -238,19 +238,19 @@ <h2>Installing with pip<a class="headerlink" href="#installing-with-pip" title="
238238
<li><p><strong>Python Version</strong>: &gt;= 3.8</p></li>
239239
<li><p><strong>CUDA Version</strong>: &gt;= 11.0</p></li>
240240
</ul>
241-
<p>The easiest way to install TileLang is directly from PyPI using pip. To install the latest version, run the following command in your terminal:</p>
241+
<p>The easiest way to install <strong>tile-lang</strong> is directly from PyPI using pip. To install the latest version, run the following command in your terminal:</p>
242242
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>tilelang
243243
</pre></div>
244244
</div>
245-
<p>Alternatively, you may choose to install TileLang using prebuilt packages available on the Release Page:</p>
245+
<p>Alternatively, you may choose to install <strong>tile-lang</strong> using prebuilt packages available on the Release Page:</p>
246246
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>tilelang-0.0.0.dev0+ubuntu.20.4.cu120-py3-none-any.whl
247247
</pre></div>
248248
</div>
249-
<p>To install the latest version of TileLang from the GitHub repository, you can run the following command:</p>
249+
<p>To install the latest version of <strong>tile-lang</strong> from the GitHub repository, you can run the following command:</p>
250250
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/tile-ai/tilelang.git
251251
</pre></div>
252252
</div>
253-
<p>After installing TileLang, you can verify the installation by running:</p>
253+
<p>After installing <strong>tile-lang</strong>, you can verify the installation by running:</p>
254254
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-c<span class="w"> </span><span class="s2">&quot;import tilelang; print(tilelang.__version__)&quot;</span>
255255
</pre></div>
256256
</div>
@@ -263,26 +263,26 @@ <h2>Building from Source<a class="headerlink" href="#building-from-source" title
263263
<li><p><strong>Python Version</strong>: &gt;= 3.7</p></li>
264264
<li><p><strong>CUDA Version</strong>: &gt;= 10.0</p></li>
265265
</ul>
266-
<p>We recommend using a Docker container with the necessary dependencies to build TileLang from source. You can use the following command to run a Docker container with the required dependencies:</p>
266+
<p>We recommend using a Docker container with the necessary dependencies to build <strong>tile-lang</strong> from source. You can use the following command to run a Docker container with the required dependencies:</p>
267267
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>run<span class="w"> </span>--gpus<span class="w"> </span>all<span class="w"> </span>-it<span class="w"> </span>--rm<span class="w"> </span>--ipc<span class="o">=</span>host<span class="w"> </span>nvcr.io/nvidia/pytorch:23.01-py3
268268
</pre></div>
269269
</div>
270-
<p>To build and install TileLang directly from source, follow these steps. This process requires certain pre-requisites from Apache TVM, which can be installed on Ubuntu/Debian-based systems using the following commands:</p>
270+
<p>To build and install <strong>tile-lang</strong> directly from source, follow these steps. This process requires certain pre-requisites from Apache TVM, which can be installed on Ubuntu/Debian-based systems using the following commands:</p>
271271
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt-get<span class="w"> </span>update
272272
sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>python3<span class="w"> </span>python3-dev<span class="w"> </span>python3-setuptools<span class="w"> </span>gcc<span class="w"> </span>libtinfo-dev<span class="w"> </span>zlib1g-dev<span class="w"> </span>build-essential<span class="w"> </span>cmake<span class="w"> </span>libedit-dev<span class="w"> </span>libxml2-dev
273273
</pre></div>
274274
</div>
275-
<p>After installing the prerequisites, you can clone the TileLang repository and install it using pip:</p>
275+
<p>After installing the prerequisites, you can clone the <strong>tile-lang</strong> repository and install it using pip:</p>
276276
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>--recursive<span class="w"> </span>https://github.com/tile-ai/tilelang.git
277277
<span class="nb">cd</span><span class="w"> </span>tileLang
278278
pip<span class="w"> </span>install<span class="w"> </span>.<span class="w"> </span><span class="c1"># Please be patient, this may take some time.</span>
279279
</pre></div>
280280
</div>
281-
<p>If you want to install TileLang in development mode, you can run the following command:</p>
281+
<p>If you want to install <strong>tile-lang</strong> in development mode, you can run the following command:</p>
282282
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
283283
</pre></div>
284284
</div>
285-
<p>We currently provide three methods to install <strong>TileLang</strong>:</p>
285+
<p>We currently provide three methods to install <strong>tile-lang</strong>:</p>
286286
<ol class="arabic simple">
287287
<li><p><a class="reference internal" href="#install-method-1">Install from Source (using your own TVM installation)</a></p></li>
288288
<li><p><a class="reference internal" href="#install-method-2">Install from Source (using the bundled TVM submodule)</a></p></li>
@@ -372,6 +372,17 @@ <h2>Building from Source<a class="headerlink" href="#building-from-source" title
372372
</div>
373373
</section>
374374
</section>
375+
<section id="install-with-nightly-version">
376+
<h2>Install with Nightly Version<a class="headerlink" href="#install-with-nightly-version" title="Permalink to this heading">#</a></h2>
377+
<p>For users who want access to the latest features and improvements before official releases, we provide nightly builds of <strong>tile-lang</strong>.</p>
378+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>tilelang<span class="w"> </span>-f<span class="w"> </span>https://tile-ai.github.io/whl/nightly/cu121/
379+
<span class="c1"># or pip install tilelang --find-links https://tile-ai.github.io/whl/nightly/cu121/</span>
380+
</pre></div>
381+
</div>
382+
<blockquote>
383+
<div><p><strong>Note:</strong> Nightly builds contain the most recent code changes but may be less stable than official releases. They’re ideal for testing new features or if you need a specific bugfix that hasn’t been released yet.</p>
384+
</div></blockquote>
385+
</section>
375386
</section>
376387

377388
</article>
@@ -437,6 +448,7 @@ <h2>Building from Source<a class="headerlink" href="#building-from-source" title
437448
<li><a class="reference internal" href="#method-3-install-using-the-provided-script">Method 3: Install Using the Provided Script</a></li>
438449
</ul>
439450
</li>
451+
<li><a class="reference internal" href="#install-with-nightly-version">Install with Nightly Version</a></li>
440452
</ul>
441453
</li>
442454
</ul>

index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,7 @@ <h1>👋 Welcome to Tile Language<a class="headerlink" href="#welcome-to-tile-la
242242
<li class="toctree-l1"><a class="reference internal" href="get_started/Installation.html">Installation Guide</a><ul>
243243
<li class="toctree-l2"><a class="reference internal" href="get_started/Installation.html#installing-with-pip">Installing with pip</a></li>
244244
<li class="toctree-l2"><a class="reference internal" href="get_started/Installation.html#building-from-source">Building from Source</a></li>
245+
<li class="toctree-l2"><a class="reference internal" href="get_started/Installation.html#install-with-nightly-version">Install with Nightly Version</a></li>
245246
</ul>
246247
</li>
247248
<li class="toctree-l1"><a class="reference internal" href="get_started/overview.html">The Tile Language: A Brief Introduction</a><ul>

0 commit comments

Comments
 (0)