Docs: modernize README — position as JVM-native LLM inference & serving engine#136
Open
mikepapadim wants to merge 2 commits into
Open
Docs: modernize README — position as JVM-native LLM inference & serving engine#136mikepapadim wants to merge 2 commits into
mikepapadim wants to merge 2 commits into
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.
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 sections
--server,/v1/chat/completions, streaming) — OpenAI-compatible server (llama-tornado --server): /v1/chat/completions + /v1/completions, streaming, zero-dep #135--benchllama-bench-style benchmarking — Add llama-bench-style benchmark: llama-tornado --bench (pp/tg/pg matrix, avg±stddev t/s, md/csv/json) #133Preserved (verbatim where it matters)
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.--helpoutput 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
docs/ll.gif,docs/inter-output.gif, roadmap/optimizations docs) are unchanged and verified to exist.