[Docs] Add docstrings to JIT kernel include headers - #19770
Conversation
github-actions
Bot
added
the
documentation
Summary of ChangesHello, 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 documentation for the JIT kernel infrastructure by adding detailed docstrings to its core C++/CUDA header files. This effort aims to make the codebase more accessible and understandable for developers, particularly new contributors, by clarifying the purpose and usage of various components. Additionally, a new reference section has been integrated into the developer guide to provide a high-level overview of these headers. 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. Changelog
Activity
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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds Doxygen-style documentation to several JIT kernel headers and a reference table to the developer guide. My review found one area where the documentation could be made more complete and consistent. Otherwise, the changes appear to be in order.
8a9af7e to
1f7c7ab
Compare
9f30ae0 to
09c9895
Compare
|
@xingsy97 Can you rebase the pr and we can merge it. |
7c255b2 to
f72b175
Compare
Add doxygen-style doc comments to the 13 headers under jit_kernel/include/sgl_kernel/. Also add a header reference table to the JIT kernel dev guide. Part of sgl-project#17035.
f72b175 to
eaebccd
Compare
| } | ||
|
|
||
| /// \brief Returns sin(a). | ||
|
|
There was a problem hiding this comment.
Remove this empty line.
3 participants
Motivation
See #17035 (Future Work -> Better documentation)
Headers under
jit_kernel/include/sgl_kernel/have few or no comments. Add doxygen-style doc comments and a reference table in the dev guide.Modifications
Add doc comments to all 12 headers under
jit_kernel/include/sgl_kernel/(atomic,cta,math,runtime,source_location,tensor,tile,type,utils.cuh,utils.h,vec,warp). No functional changes.Add "C++ Include Library Reference" section to
docs/developer_guide/development_jit_kernel_guide.md.Checklist