Skip to content

Docs: modernize README — position as JVM-native LLM inference & serving engine#136

Open
mikepapadim wants to merge 2 commits into
mainfrom
readme-vllm-refresh
Open

Docs: modernize README — position as JVM-native LLM inference & serving engine#136
mikepapadim wants to merge 2 commits into
mainfrom
readme-vllm-refresh

Conversation

@mikepapadim

Copy link
Copy Markdown
Member

Summary

Modernizes the README to position GPULlama3.java clearly as a JVM-native LLM inference & serving engine — the vLLM-style path for the Java ecosystem — while preserving all existing content. Trims 517 → 329 lines and makes it far more scannable.

Docs-only change: README.md.

What changed

Positioning

  • New hero: "Think vLLM — but pure Java, and it runs on any GPU." Frames the project as an inference and serving engine, not just a model runner.
  • Aligns tone with the TornadoVM site branding ("Java on GPUs. And more.", "no JNI glue, no second toolchain"): code-first, benchmark-driven, scannable.

New sections

Preserved (verbatim where it matters)

  • Performance table, all model collections, Maven coordinates (0.5.0 / 0.5.0-jdk25), the LangChain4j example, llama-tornado / llamaTornado / JBang / Docker usage, GPU-memory guidance, funding, MIT, and both demo GIFs.
  • The full --help output and debug flags are kept behind a collapsible block, folded into an "Embed in your own tools" section alongside --show-command.

Restructured for scannability
Why → Quickstart → Performance → Serving → LangChain4j/Quarkus + Maven → Install → CLI (llama-tornado / llamaTornado / JBang / Docker) → Models → GPU memory → Embed & options → Roadmap → Acknowledgments → License. Emoji section accents throughout, consistent with the TornadoVM docs style.

Notes

  • The serving features are unmerged PRs, so they are presented as preview with links rather than claimed as shipped — happy to promote them once merged.
  • No code changes; badges and asset paths (docs/ll.gif, docs/inter-output.gif, roadmap/optimizations docs) are unchanged and verified to exist.

Copilot AI review requested due to automatic review settings July 16, 2026 19:23

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Copilot AI review requested due to automatic review settings July 16, 2026 19:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants