Skip to content

Conversation

@junrushao
Copy link
Member

Made a few changes:

  • Migrate examples/packaging -> examples/python_packaging
  • Add a prerequisite section
  • Use literalinclude to include code from examples/python_packaging to the tutorial
  • Point to Python package docs in tvm-ffi-stubgen helper messages

@junrushao junrushao marked this pull request as ready for review December 22, 2025 05:37
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @junrushao, 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 significantly improves the Python packaging documentation by reorganizing example code, enhancing clarity with new sections and direct code inclusions, and updating the example C++ extension and its corresponding Python usage. These changes aim to provide a more accurate, maintainable, and user-friendly guide for developers working with TVM-FFI Python packaging.

Highlights

  • Example Directory Migration: The examples/packaging directory has been renamed to examples/python_packaging to better reflect its content and purpose, ensuring a clearer structure for Python packaging examples.
  • Documentation Enhancement: The python_packaging.rst documentation now includes a new 'Prerequisite' section and utilizes literalinclude directives to directly embed code snippets from the example files. This change ensures consistency between the documentation and the actual source code, making it easier to maintain and more accurate.
  • Simplified C++ Extension Example: The extension.cc example has been refactored to be more concise, focusing on core FFI concepts like ABI-exported functions (AddTwo), global registry functions (AddOne, RaiseError), and simplified object definitions (IntPairObj with a Sum method). This removes TensorView examples and streamlines object usage.
  • Updated Stub Generation Tool Help: The tvm-ffi-stubgen command-line interface help message has been streamlined. It now removes verbose examples and includes a direct link to the relevant Python packaging documentation, improving user guidance.
  • Example Script Alignment: The run_example.py script and Python stub files (_ffi_api.py) have been updated to reflect the changes in the C++ extension. This includes new function calls, simplified object attribute access, and removal of the torch dependency from the example.

🧠 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.

Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/ci_mainline_only.yml
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

This pull request primarily refactors and updates the Python packaging example for TVM-FFI. It deletes the old example.cc and introduces a new extension.cc which defines AddTwo (exported via TVM-FFI ABI), AddOne (registered globally), RaiseError, and an IntPairObj with a, b fields and a Sum method. The documentation (docs/packaging/python_packaging.rst) is updated to use literalinclude directives to pull code snippets directly from these example files, along with adding prerequisites and a note about the example code location. The CMakeLists.txt and pyproject.toml files in the example are updated with markers and explicit wheel configuration. The README.md is adjusted to reflect the new example structure and the four demonstration flows. Python stub files (_ffi_api.py) are updated to reflect the new add_one function and the IntPair object's sum method, replacing previous methods. Finally, the run_example.py script is modified to call the new add_two function, update add_one to a simpler integer operation, and correctly interact with the revised IntPair object. The tvm-ffi-stubgen CLI tool's help text is also simplified, pointing to external documentation.

@tqchen tqchen merged commit dc0dd2f into apache:main Dec 22, 2025
7 checks passed
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