Skip to content

Commit cad3573

Browse files
authored
[Doc] update installation.md and readme (#22)
* [Doc] update installation.md and readme * solve conflicts * change readme * fix installation.rst * fix readme * fix installation
1 parent e5d5cdd commit cad3573

File tree

5 files changed

+22
-266
lines changed

5 files changed

+22
-266
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ pip install . # with -e option if you want to install in editable mode
7171

7272
### Method 2: Build from Source
7373
We currently provide three ways to install **tile-lang** from source:
74-
- [Install from Source (using your own TVM installation)](./docs/Installation.md#install-from-source-with-your-own-tvm-installation)
75-
- [Install from Source (using the bundled TVM submodule)](./docs/Installation.md#install-from-source-with-our-tvm-submodule)
76-
- [Install Using the Provided Script](./docs/Installation.md#install-with-provided-script)
74+
- [Install from Source (using your own TVM installation)](./docs/get_started/Installation.rst#method-1-install-from-source-using-your-own-tvm-installation)
75+
- [Install from Source (using the bundled TVM submodule)](./docs/get_started/Installation.rst#method-2-install-from-source-with-our-tvm-submodule)
76+
- [Install Using the Provided Script](./docs/get_started/Installation.rst##method-3-install-using-the-provided-script)
7777

7878

7979
## Quick Start
@@ -192,6 +192,12 @@ In addition to GEMM, we provide a variety of examples to showcase the versatilit
192192

193193
TileLang has now been used in project [BitBLAS](https://github.com/microsoft/BitBLAS).
194194

195+
## Join the Discussion
196+
197+
Welcome to join our Discord community for discussions, support, and collaboration!
198+
199+
[![Join our Discord](https://img.shields.io/badge/Discord-Join%20Us-blue?logo=discord&style=for-the-badge)](https://discord.gg/TUrHyJnKPG)
200+
195201
## Acknowledgements
196202

197203
We learned a lot from the [TVM](https://github.com/apache/tvm) community and would like to thank them for their contributions. The initial version of this project is mainly contributed by [LeiWang1999](https://github.com/LeiWang1999), [chengyupku](https://github.com/chengyupku) and [nox-410](https://github.com/nox-410). Part of this work was done during the internship at Microsoft Research, under the supervision of Dr. Lingxiao Ma, Dr. Yuqing Xia, Dr. Jilong Xue, and Dr. Fan Yang.

deprecated/docs/Installation.md

Lines changed: 0 additions & 166 deletions
This file was deleted.

deprecated/docs/flash_perf.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

deprecated/docs/language_ref.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/get_started/Installation.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ After installing the prerequisites, you can clone the TileLang repository and in
6565
.. code:: bash
6666
6767
git clone --recursive https://github.com/tile-ai/tilelang.git
68-
cd TileLang
68+
cd tileLang
6969
pip install . # Please be patient, this may take some time.
7070
7171
If you want to install TileLang in development mode, you can run the following command:
@@ -76,11 +76,13 @@ If you want to install TileLang in development mode, you can run the following c
7676
7777
We currently provide three methods to install **TileLang**:
7878

79-
1. Install from Source (using your own TVM installation)
79+
1. `Install from Source (using your own TVM installation)`_
80+
2. `Install from Source (using the bundled TVM submodule)`_
81+
3. `Install Using the Provided` Script_
8082

81-
2. Install from Source (using the bundled TVM submodule)
82-
83-
3. Install Using the Provided Script
83+
.. _Install from Source (using your own TVM installation): #method-1-install-from-source-using-your-own-tvm-installation
84+
.. _Install from Source (using the bundled TVM submodule): #method-2-install-from-source-using-the-bundled-tvm-submodule
85+
.. _Install Using the Provided Script: #method-3-install-using-the-provided-script
8486

8587

8688
Method 1: Install from Source (Using Your Own TVM Installation)
@@ -93,7 +95,7 @@ If you already have a compatible TVM installation, follow these steps:
9395
.. code:: bash
9496
9597
git clone --recursive https://github.com/tile-ai/tilelang
96-
cd TileLang
98+
cd tilelang
9799
98100
**Note**: Use the `--recursive` flag to include necessary submodules.
99101

@@ -114,7 +116,7 @@ If you already have a compatible TVM installation, follow these steps:
114116

115117
.. code:: bash
116118
117-
export PYTHONPATH=/your/path/to/tile-lang/python:$PYTHONPATH
119+
export PYTHONPATH=/your/path/to/tilelang/:$PYTHONPATH
118120
# TVM_IMPORT_PYTHON_PATH is used by 3rd-party frameworks to import TVM
119121
export TVM_IMPORT_PYTHON_PATH=/your/path/to/tvm/python
120122
@@ -128,7 +130,7 @@ If you prefer to use the built-in TVM version, follow these instructions:
128130
.. code:: bash
129131
130132
git clone --recursive https://github.com/tile-ai/tilelang
131-
cd TileLang
133+
cd tilelang
132134
133135
**Note**: Ensure the `--recursive` flag is included to fetch submodules.
134136

@@ -155,7 +157,7 @@ If you prefer to use the built-in TVM version, follow these instructions:
155157

156158
.. code:: bash
157159
158-
export PYTHONPATH=/your/path/to/TileLang/python:$PYTHONPATH
160+
export PYTHONPATH=/your/path/to/tilelang/:$PYTHONPATH
159161
160162
Method 3: Install Using the Provided Script
161163
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -167,11 +169,11 @@ For a simplified installation, use the provided script:
167169
.. code:: bash
168170
169171
git clone --recursive https://github.com/tile-ai/tilelang
170-
cd TileLang
172+
cd tilelang
171173
172174
2. **Run the Installation Script**:
173175

174176
.. code:: bash
175177
176-
bash install.sh
178+
bash install_cuda.sh
177179
# or bash `install_amd.sh` if you want to enable ROCm runtime

0 commit comments

Comments
 (0)