[Documentation]: Add comprehensive Doxygen-style documentation to origami.py and matmul.py#28
Draft
[Documentation]: Add comprehensive Doxygen-style documentation to origami.py and matmul.py#28
Conversation
Co-authored-by: neoblizz <9790745+neoblizz@users.noreply.github.com>
Co-authored-by: neoblizz <9790745+neoblizz@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [Documentation]: Need In-Code Function/API Documentation
[Documentation]: Add comprehensive Doxygen-style documentation to origami.py and matmul.py
Sep 27, 2025
ryanswann-amd
pushed a commit
to ryanswann-amd/tritonBLAS
that referenced
this pull request
Apr 12, 2026
ryanswann-amd
pushed a commit
to ryanswann-amd/tritonBLAS
that referenced
this pull request
Apr 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds comprehensive Doxygen-style documentation to the core TritonBLAS API files as requested in issue #X. The documentation provides complete API reference material for both users and contributors.
Files Updated
include/tritonblas/origami.pydtype_to_strmapping with inline comments for each PyTorch data typeinclude/tritonblas/matmul.py_make_matmul_selector(): LRU caching mechanism and performance benefitspersistent_matmul_lt()andstreamk_matmul_lt(): Detailed execution mode comparisonsmatmul_lt()andmatmul(): User-facing APIs with usage examples and code snippetsDocumentation Features
@brief,@param,@return,@details,@see,@throws,@pre,@note)Usage Example
The documentation now enables users to understand the full API:
This documentation will significantly improve the developer experience and reduce the learning curve for new contributors to the TritonBLAS project.
Fixes #X
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.