docs: add troubleshooting guide, tensor shapes reference, and FAQ#147
Open
yurekami wants to merge 1 commit into
Open
docs: add troubleshooting guide, tensor shapes reference, and FAQ#147yurekami wants to merge 1 commit into
yurekami wants to merge 1 commit into
Conversation
Add comprehensive documentation to help users: - TROUBLESHOOTING.md: GPU compatibility matrix (SM90/SM100/SM120), build error solutions, common runtime errors, and workarounds - TENSOR_SHAPES.md: Complete tensor shape reference for all major functions with ASCII diagrams and common error fixes - FAQ.md: Answers to frequently asked questions based on GitHub issues These documents address recurring questions from issues deepseek-ai#101, deepseek-ai#108, deepseek-ai#110, deepseek-ai#113, deepseek-ai#116, deepseek-ai#119, deepseek-ai#121, deepseek-ai#124, deepseek-ai#126 and should reduce support burden while improving developer onboarding. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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.
Summary
This PR adds three comprehensive documentation files to help users troubleshoot issues, understand tensor shapes, and find answers to common questions. These documents are based on analysis of 53+ open GitHub issues and address the most frequent pain points reported by the community.
Changes
docs/TROUBLESHOOTING.md- GPU compatibility matrix, build error solutions, common runtime errorsdocs/TENSOR_SHAPES.md- Complete tensor shape reference for all major functionsdocs/FAQ.md- Answers to frequently asked questions from GitHub issuesMotivation
The FlashMLA repository has 53+ open issues, many of which are:
This documentation directly addresses these recurring questions, which should:
Documentation Overview
TROUBLESHOOTING.md
TENSOR_SHAPES.md
flash_mla_with_kvcacheget_mla_metadataflash_mla_prefillmha_fwd_kvcacheFAQ.md
Related Issues
This documentation addresses questions raised in:
Test Plan
🤖 Generated with Claude Code