Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ pip install . # with -e option if you want to install in editable mode

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


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

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

## Join the Discussion

Welcome to join our Discord community for discussions, support, and collaboration!

[![Join our Discord](https://img.shields.io/badge/Discord-Join%20Us-blue?logo=discord&style=for-the-badge)](https://discord.gg/TUrHyJnKPG)

## Acknowledgements

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.
166 changes: 0 additions & 166 deletions deprecated/docs/Installation.md

This file was deleted.

25 changes: 0 additions & 25 deletions deprecated/docs/flash_perf.md

This file was deleted.

61 changes: 0 additions & 61 deletions deprecated/docs/language_ref.md

This file was deleted.

24 changes: 13 additions & 11 deletions docs/get_started/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ After installing the prerequisites, you can clone the TileLang repository and in
.. code:: bash

git clone --recursive https://github.com/tile-ai/tilelang.git
cd TileLang
cd tileLang
pip install . # Please be patient, this may take some time.

If you want to install TileLang in development mode, you can run the following command:
Expand All @@ -76,11 +76,13 @@ If you want to install TileLang in development mode, you can run the following c

We currently provide three methods to install **TileLang**:

1. Install from Source (using your own TVM installation)
1. `Install from Source (using your own TVM installation)`_
2. `Install from Source (using the bundled TVM submodule)`_
3. `Install Using the Provided` Script_

2. Install from Source (using the bundled TVM submodule)

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


Method 1: Install from Source (Using Your Own TVM Installation)
Expand All @@ -93,7 +95,7 @@ If you already have a compatible TVM installation, follow these steps:
.. code:: bash

git clone --recursive https://github.com/tile-ai/tilelang
cd TileLang
cd tilelang

**Note**: Use the `--recursive` flag to include necessary submodules.

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

.. code:: bash

export PYTHONPATH=/your/path/to/tile-lang/python:$PYTHONPATH
export PYTHONPATH=/your/path/to/tilelang/:$PYTHONPATH
# TVM_IMPORT_PYTHON_PATH is used by 3rd-party frameworks to import TVM
export TVM_IMPORT_PYTHON_PATH=/your/path/to/tvm/python

Expand All @@ -128,7 +130,7 @@ If you prefer to use the built-in TVM version, follow these instructions:
.. code:: bash

git clone --recursive https://github.com/tile-ai/tilelang
cd TileLang
cd tilelang

**Note**: Ensure the `--recursive` flag is included to fetch submodules.

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

.. code:: bash

export PYTHONPATH=/your/path/to/TileLang/python:$PYTHONPATH
export PYTHONPATH=/your/path/to/tilelang/:$PYTHONPATH

Method 3: Install Using the Provided Script
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -167,11 +169,11 @@ For a simplified installation, use the provided script:
.. code:: bash

git clone --recursive https://github.com/tile-ai/tilelang
cd TileLang
cd tilelang

2. **Run the Installation Script**:

.. code:: bash

bash install.sh
bash install_cuda.sh
# or bash `install_amd.sh` if you want to enable ROCm runtime