Expands API documentation with comprehensive interface guide #83
Conversation
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
Restructures documentation to provide complete coverage of all available functions and interfaces including high-level auto-selection, packed variants, and variable length support. Adds detailed usage examples for standard attention, dynamic masking, grouped-query attention, and variable length sequences with performance optimization tips. Includes troubleshooting section covering common import errors, performance issues, and debugging techniques with memory monitoring utilities.
LoserCheems
requested review from
Evanwu1125,
SNHuan,
Copilot and
wubingheng111
and removed request for
Copilot
Ensures all code examples include proper device and dtype variable definitions to prevent NameError when users run the sample code. Also adds missing math import for completeness.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR significantly expands and restructures the API documentation to provide comprehensive coverage of all available functions and interfaces in the Flash Dynamic Mask Attention library. The documentation is transformed from a basic reference to a complete guide with practical examples and troubleshooting information.
Key changes include:
- Restructured API organization with high-level auto-selection functions, packed variants, and variable length support
- Added detailed usage examples for standard attention, dynamic masking, grouped-query attention, and variable length sequences
- Included performance optimization tips and comprehensive troubleshooting section with memory monitoring utilities
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.
Restructures documentation to provide complete coverage of all available functions and interfaces including high-level auto-selection, packed variants, and variable length support.
Adds detailed usage examples for standard attention, dynamic masking, grouped-query attention, and variable length sequences with performance optimization tips.
Includes troubleshooting section covering common import errors, performance issues, and debugging techniques with memory monitoring utilities.