docs: improve README readability and structure#6
Merged
wangleiofficial merged 1 commit intomainfrom Mar 1, 2026
Merged
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
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.
Motivation
Description
Table of contentssection for quick navigation toInstallation,Model details,Usage,License, andCitationsections.Installationsection to call out thePyTorchprerequisite and present two install options with clearpipcommands (git+httpsfor latest andProtFlashfrom PyPI for stable).Model detailstable for clearer columns and tidy theUsageexamples by addingpython-marked code blocks and restructuring theFLASHTransformerconstructor across multiple lines for readability.Testing
git diff -- README.md | sed -n '1,260p'to review the patch and it completed successfully.nl -ba README.md | sed -n '1,220p'to inspect the updated file contents and it completed successfully.git status --shortto verify the working tree state before finalizing edits and it completed successfully.Codex Task