Skip to content

Cleanup/readme documentation updates#70

Merged
markurtz merged 14 commits intomainfrom
cleanup/readme-documentation-updates
Jul 30, 2025
Merged

Cleanup/readme documentation updates#70
markurtz merged 14 commits intomainfrom
cleanup/readme-documentation-updates

Conversation

@rahul-tuli
Copy link
Copy Markdown
Collaborator

@rahul-tuli rahul-tuli commented Jul 30, 2025 •
edited
Loading

Changes Made

  • README.md Updates:
    • Replaced broken speculators logo with centered "Speculators" heading placeholder
    • Removed "Version" and "Documentation" shields (no published version yet)
    • Added intro paragraph explaining speculative decoding as a lossless latency improvement method using smaller models to predict larger model tokens
    • Enhanced Key Features section:
      • Expanded speculative decoding description to emphasize unified research library
      • Improved standardized format explanation highlighting HuggingFace compatibility and conversion support
      • Strengthened vLLM integration messaging as preferred deployment pathway
      • Removed "Productization Tools" bullet point
    • Simplified installation to source-only (removed PyPI references)
    • Removed Quick Start section
    • Updated Resources section:
      • Added research implementations with links and explanations
      • Removed documentation and releases sections
  • Documentation cleanup:
    • Removed docs folder and empty README.md
@rahul-tuli
Update README.md and Remove docs/ folder
39492d3 
Signed-off-by: Rahul Tuli <rtuli@redhat.com>
@rahul-tuli
typo
c391edf 
Signed-off-by: Rahul Tuli <rtuli@redhat.com>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jul 30, 2025 •
edited
Loading

📦 Build Artifacts Available
The build artifacts (`.whl` and `.tar.gz`) have been successfully generated and are available for download: https://github.com/neuralmagic/speculators/actions/runs/16628322656/artifacts/3650619286.
They will be retained for up to 30 days.
Commit: 721e411
@rahul-tuli
Remove redundant wording
a2a4a0e 
Signed-off-by: Rahul Tuli <rtuli@redhat.com>
@rahul-tuli
Remove redundant wording, Center Heading
3b70c50 
Signed-off-by: Rahul Tuli <rtuli@redhat.com>
@rahul-tuli
Center Heading
7f8338d 
Signed-off-by: Rahul Tuli <rtuli@redhat.com>
@rahul-tuli rahul-tuli marked this pull request as ready for review July 30, 2025 13:23
shanjiaz
shanjiaz approved these changes Jul 30, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@shanjiaz shanjiaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Thanks for cleaning this up.
dsikka
dsikka approved these changes Jul 30, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@dsikka dsikka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
rahul-tuli and others added 3 commits July 30, 2025 09:54
@rahul-tuli
Center Shields
903632c 
Signed-off-by: Rahul Tuli <rtuli@redhat.com>
@rahul-tuli
Fix style
77fe41f 
Signed-off-by: Rahul Tuli <rtuli@redhat.com>
@markurtz
typing fixes
35de939
markurtz
markurtz reviewed Jul 30, 2025
View reviewed changes
rahul-tuli and others added 6 commits July 30, 2025 12:30
@rahul-tuli @markurtz
Apply suggestion from @markurtz
e4e3729 
Co-authored-by: Mark Kurtz <mark.j.kurtz@gmail.com>
@rahul-tuli @markurtz
Apply suggestion from @markurtz
73fafd9 
Co-authored-by: Mark Kurtz <mark.j.kurtz@gmail.com>
@rahul-tuli @markurtz
Apply suggestion from @markurtz
9559913 
Co-authored-by: Mark Kurtz <mark.j.kurtz@gmail.com>
@rahul-tuli @markurtz
Apply suggestion from @markurtz
b3c3098 
Co-authored-by: Mark Kurtz <mark.j.kurtz@gmail.com>
@rahul-tuli @markurtz
Apply suggestion from @markurtz
cd11d6c 
Co-authored-by: Mark Kurtz <mark.j.kurtz@gmail.com>
@rahul-tuli @markurtz
Update README.md
721e411 
Co-authored-by: Mark Kurtz <mark.j.kurtz@gmail.com>
@markurtz markurtz merged commit eac751f into main Jul 30, 2025
10 checks passed
@markurtz markurtz deleted the cleanup/readme-documentation-updates branch July 30, 2025 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants

@rahul-tuli @markurtz @dsikka @shanjiaz