Skip to content

[DOC] Update installation docs with missing dependencies (#18194)#18808

Open
AshwiniBokka wants to merge 2 commits intoapache:mainfrom
AshwiniBokka:fix-install-docs-18194
Open

[DOC] Update installation docs with missing dependencies (#18194)#18808
AshwiniBokka wants to merge 2 commits intoapache:mainfrom
AshwiniBokka:fix-install-docs-18194

Conversation

@AshwiniBokka
Copy link
Contributor

Fixes #18194

Based on user report, the installation documentation was missing:

  1. System dependencies (zlib1g-dev, libxml2-dev)
  2. Cython in Python dependencies
  3. Post-build installation step (cd python && pip install -e .)

This PR adds these missing steps to from_source.rst:

  • Added 'System Dependencies' section with Ubuntu commands
  • Added Cython to the necessary dependencies
  • Added 'Installing the Python Package' section after build

Changes:

  • 24 insertions, 1 deletion
  • Only 1 file changed (docs/install/from_source.rst)

This addresses all 4 issues reported by the user in #18194.

Based on user report, the installation documentation was missing:
1. System dependencies (zlib1g-dev, libxml2-dev)
2. Cython in Python dependencies
3. Post-build installation step (cd python && pip install -e .)

This PR adds these missing steps to rom_source.rst:

- Added 'System Dependencies' section with Ubuntu commands
- Added Cython to the necessary dependencies
- Added 'Installing the Python Package' section after build

Fixes apache#18194
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @AshwiniBokka, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the installation documentation for building from source, addressing a user report by incorporating crucial missing steps. The changes enhance the clarity and completeness of the installation guide by adding system-level dependencies, an additional Python dependency (Cython), and the final post-build installation command for the Python package, ensuring a smoother setup process for users.

Highlights

  • System Dependencies: Added a new section detailing required system libraries (zlib1g-dev, libxml2-dev) for Ubuntu/Debian systems to the installation guide.
  • Python Dependencies: Included Cython in the list of necessary Python dependencies for building from source.
  • Post-Build Installation: Introduced a new section guiding users to install the Python package after a successful build using 'cd python && pip install -e .'.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/install/from_source.rst
    • Added a 'System Dependencies' section with 'apt' commands for 'zlib1g-dev' and 'libxml2-dev'.
    • Updated the 'Necessary dependencies' list to include 'cython'.
    • Added an 'Installing the Python Package' section with instructions for 'pip install -e .'.
Activity
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request correctly identifies several missing dependencies and steps in the TVM installation documentation. Specifically, adding cython and the required system libraries (zlib1g-dev, libxml2-dev) is a valuable improvement for users not using the Conda-based setup. However, the placement of the "System Dependencies" section is logically inconsistent with the document's flow, as these libraries are required for the build process (Step 3) rather than being "Extra Python Dependencies" (Step 5). Additionally, the new "Installing the Python Package" section is redundant with instructions already present at the end of Step 3. The section headers also introduce an inconsistency in the document's heading hierarchy.

@yongwww
Copy link
Member

yongwww commented Feb 25, 2026

@tvm-bot run

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.

[Bug] the latest doc about installing tvm from source code is not complete.

2 participants