Skip to content

[Doc] Update doc, add troubleshooting section#1485

Closed
oraluben wants to merge 2 commits intotile-ai:mainfrom
oraluben:install-doc-update
Closed

[Doc] Update doc, add troubleshooting section#1485
oraluben wants to merge 2 commits intotile-ai:mainfrom
oraluben:install-doc-update

Conversation

@oraluben
Copy link
Collaborator

@oraluben oraluben commented Dec 21, 2025

The purpose of this PR is to inform user that install with uv pip and without --no-build-isolation might cause runtime issue about z3:

(tilelang) [yyc@iZmj7cfy2ysqwfo0nrci4pZ tilelang]$ uv pip install . -v
...
(tilelang) [yyc@iZmj7cfy2ysqwfo0nrci4pZ tilelang]$ python -c 'import tilelang'
2025-12-21 13:47:29  [TileLang:tilelang.env:WARNING]: Loading tilelang libs from dev root: /home/yyc/repo/tilelang/build
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/home/yyc/repo/tilelang/tilelang/__init__.py", line 101, in <module>
    import tvm
  File "/home/yyc/repo/tilelang/3rdparty/tvm/python/tvm/__init__.py", line 27, in <module>
    from .base import TVMError, __version__, _RUNTIME_ONLY
  File "/home/yyc/repo/tilelang/3rdparty/tvm/python/tvm/base.py", line 58, in <module>
    _LIB, _LIB_NAME = _load_lib()
                      ^^^^^^^^^^^
  File "/home/yyc/repo/tilelang/3rdparty/tvm/python/tvm/base.py", line 45, in _load_lib
    lib = ctypes.CDLL(lib_path[0], ctypes.RTLD_GLOBAL)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/yyc/.local/share/uv/python/cpython-3.12.12-linux-x86_64-gnu/lib/python3.12/ctypes/__init__.py", line 379, in __init__
    self._handle = _dlopen(self._name, mode)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^
OSError: libz3.so: cannot open shared object file: No such file or directory

This PR also refactor a lot about install instructions, move most of them into Installation.md.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 21, 2025

Walkthrough

Streamlined README.md installation section to a single quick-install command with link to advanced guide. Expanded docs/get_started/Installation.md with Docker installation, nightly builds, and reorganized guidance sections, removing duplicate content.

Changes

Cohort / File(s) Change Summary
README.md Installation Simplification
README.md
Consolidated multiple installation methods (Method 1, 2, 3) into single quick-install pip command. Replaced detailed nightly-build instructions with advanced installation note and link to Installation Guide. Streamlined overall installation flow.
Installation Guide Expansion
docs/get_started/Installation.md
Added nightly builds installation pathway. Added comprehensive Docker installation section with prerequisites, image building, container execution, and verification steps. Introduced "Other Tips" section consolidating IDE configs, compile cache, wheel repair, and environment variables. Removed duplicate Docker and nightly build sections. Retained Z3 dependency troubleshooting guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Documentation-only changes with no code logic to verify. Straightforward content consolidation and reorganization with no functional alterations.

Possibly related PRs

Suggested reviewers

  • LeiWang1999

Poem

🐰 A rabbit hops through docs so neat,
Installing paths now clean and sweet,
Quick and easy, Docker too,
Nightly builds for those bold few,
Documentation fresh and bright! 🌟

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title mentions 'troubleshooting section' but the actual changes primarily involve reorganizing installation instructions and adding nightly/Docker options; the troubleshooting aspect is secondary. Consider a more accurate title like '[Doc] Refactor installation guide and add nightly/Docker options' or clarify what troubleshooting content was added if substantial.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

👋 Hi! Thank you for contributing to the TileLang project.

Please remember to run pre-commit run --all-files in the root directory of the project to ensure your changes are properly linted and formatted. This will help ensure your contribution passes the format check.

We appreciate you taking this step! Our team will review your contribution, and we look forward to your awesome work! 🚀

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/get_started/Installation.md (1)

52-52: Minor grammar refinement needed.

Line 52 reads "use that built image on other machine" but should be "on another machine" for grammatical correctness.

🔎 Proposed fix
- **NVIDIA Docker runtime or GPU is not necessary for building tilelang, you can build on a host without GPU and use that built image on other machine.
+ **NVIDIA Docker runtime or GPU is not necessary for building tilelang, you can build on a host without GPU and use that built image on another machine.
📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e8d1f8 and a3e5f4a.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • docs/get_started/Installation.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/get_started/Installation.md

[grammar] ~52-~52: Ensure spelling is correct
Context: ...without GPU and use that built image on other machine. 1. Clone the Repository: ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ 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). (2)
  • GitHub Check: Test for Python 3.12 with Metal (on macos-latest)
  • GitHub Check: Test for Python 3.12 with Nightly-ROCm-7.1 (on self-hosted-amd)
🔇 Additional comments (4)
README.md (1)

85-98: Excellent simplification of the installation section.

The streamlined quick-install approach with a clear reference to the detailed Installation Guide is a great UX improvement. New users get a fast path to installation, while advanced users can easily find nightly builds, source builds, and Docker options.

docs/get_started/Installation.md (3)

35-45: Nightly installation section is clear and appropriately cautious.

The section provides a straightforward install command and includes a helpful stability note to set user expectations. The dual command format (with and without --find-links) provides flexibility.


46-101: Well-organized Docker installation with comprehensive guidance.

The step-by-step structure is clear, the parameter explanations are valuable, and the verification step ensures users confirm successful setup. This is a significant improvement for users who prefer containerized environments.


238-270: Troubleshooting section effectively addresses the Z3 dependency issue.

The explanation clearly contextualizes the problem (build isolation in uv environments), explains the root cause (incompatible libz3), and provides a straightforward solution. This directly fulfills the PR's objective to inform users about the Z3 installation issue and the --no-build-isolation workaround.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants