[Doc] Install docs add docker install method#961
Conversation
|
👋 Hi! Thank you for contributing to the TileLang project. Please remember to run We appreciate you taking this step! Our team will review your contribution, and we look forward to your awesome work! 🚀 |
WalkthroughThe installation guide is restructured to introduce Docker as the new Method 1 (Recommended), with detailed steps for prerequisites, clone/build/run, and verification. Existing methods are renumbered: previous Methods 1–3 become Methods 2–4. Anchors, headings, and cross-references are updated accordingly. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor U as User
participant D as Installation Docs
participant G as Git/Repo
participant DE as Docker Engine
participant C as Container
participant V as Verification
Note over D: New Method 1 (Docker) — recommended
U->>D: Read Docker-based instructions
U->>G: git clone repo
U->>DE: docker build image
DE-->>U: Build logs
U->>DE: docker run container
DE->>C: Start container
C-->>U: Runtime ready
U->>C: Execute verification command(s)
C->>V: Produce output
V-->>U: Confirm installation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/get_started/Installation.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/get_started/Installation.md
73-73: Link fragments should be valid
(MD051, link-fragments)
74-74: Link fragments should be valid
(MD051, link-fragments)
75-75: Link fragments should be valid
(MD051, link-fragments)
76-76: Link fragments should be valid
(MD051, link-fragments)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-test-amd
| 1. [Install Using Docker](#install-method-1) (Recommended) | ||
| 2. [Install from Source (using your own TVM installation)](#install-method-2) | ||
| 3. [Install from Source (using the bundled TVM submodule)](#install-method-3) | ||
| 4. [Install Using the Provided Script](#install-method-4) |
There was a problem hiding this comment.
Fix broken section links in methods list.
The fragment identifiers #install-method-1 … #install-method-4 do not match any generated IDs, so each link in the list ends up broken (see markdownlint MD051). Please point them at the actual heading slugs (or use {ref} syntax if you want myst anchors). A minimal fix is:
-1. [Install Using Docker](#install-method-1) (Recommended)
-2. [Install from Source (using your own TVM installation)](#install-method-2)
-3. [Install from Source (using the bundled TVM submodule)](#install-method-3)
-4. [Install Using the Provided Script](#install-method-4)
+1. [Install Using Docker](#method-1-install-using-docker-recommended) (Recommended)
+2. [Install from Source (Using Your Own TVM Installation)](#method-2-install-from-source-using-your-own-tvm-installation)
+3. [Install from Source (Using the Bundled TVM Submodule)](#method-3-install-from-source-using-the-bundled-tvm-submodule)
+4. [Install Using the Provided Script](#method-4-install-using-the-provided-script)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. [Install Using Docker](#install-method-1) (Recommended) | |
| 2. [Install from Source (using your own TVM installation)](#install-method-2) | |
| 3. [Install from Source (using the bundled TVM submodule)](#install-method-3) | |
| 4. [Install Using the Provided Script](#install-method-4) | |
| 1. [Install Using Docker](#method-1-install-using-docker-recommended) (Recommended) | |
| 2. [Install from Source (Using Your Own TVM Installation)](#method-2-install-from-source-using-your-own-tvm-installation) | |
| 3. [Install from Source (Using the Bundled TVM Submodule)](#method-3-install-from-source-using-the-bundled-tvm-submodule) | |
| 4. [Install Using the Provided Script](#method-4-install-using-the-provided-script) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
73-73: Link fragments should be valid
(MD051, link-fragments)
74-74: Link fragments should be valid
(MD051, link-fragments)
75-75: Link fragments should be valid
(MD051, link-fragments)
76-76: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In docs/get_started/Installation.md around lines 73-76, the list uses broken
fragment IDs (#install-method-1 … #install-method-4); update each link to the
actual heading slug (e.g. #install-using-docker,
#install-from-source-using-your-own-tvm-installation,
#install-from-source-using-the-bundled-tvm-submodule,
#install-using-the-provided-script) or replace with MyST cross-reference syntax
like {ref}`Install Using Docker <install-using-docker>` (or the equivalent for
each heading) so the anchors match the generated IDs and the links resolve.
|
@BBuf Thanks for your contribution! The difficulty in installing packages on the B200 is likely due to its ARM CPU processor. For instance, the PyTorch version in the default Docker environment doesn't support the sm100 architecture, which necessitates the manual creation of a Miniconda environment to upgrade PyTorch and install all dependencies before compiling TVM/TileLang. By 'default Docker environment,' do you mean your own environment, or the Dockerfiles we provide? |
I just follow the install doc step in ubuntu host: 
I did not use TileLang's Dockerfile to build docker image first, so I encountered above issues. |
|
I see, overall lgtm, thanks. |
2 participants
I encountered multiple issues when building TileLang from source on B200 using the tutorial. For instance, the PyTorch version in the default Docker environment doesn't support the sm100 architecture, requiring manual creation of a miniconda environment to upgrade PyTorch and install all dependencies before compiling TVM/TileLang. This process essentially equals building Docker using TileLang's provided Dockerfile. The Docker build approach is much more convenient and streamlined, completing the entire environment setup without any extra compilation overhead. Therefore, I've added a new installation method that allows users to easily set up a clean TileLang development environment on any GPU.
Summary by CodeRabbit