-
Notifications
You must be signed in to change notification settings - Fork 48
doc: Improve python packaging doc #355
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @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
🧠 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
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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.
Made a few changes:
examples/packaging->examples/python_packagingliteralincludeto include code fromexamples/python_packagingto the tutorialtvm-ffi-stubgenhelper messages