docs: promote PyTorch/LLM API backend as the default quick start - #852
Conversation
Replaces the broken Steps 2-4 in the PyTorch Backend section with commands that actually work. Key fixes: - Clone TRT-LLM source to /tmp to get the llmapi template (the git submodule in the repo is a placeholder and may be empty) - Run the server from /tmp to avoid Python resolving `tensorrt_llm` to the source tree instead of the installed package, which causes ModuleNotFoundError: No module named 'tensorrt_llm.bindings' - Add a NOTE callout explaining the import conflict pitfall - Add metrics curl example in Step 5 Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
…kend - Move PyTorch (LLM API) to the primary Getting Started section - Replace the 400-line engine backend quick start with a single link to docs/README-engine-backend-archive.md - Simplify PyTorch quick start to: git clone → edit model.yaml → launch - Add [!IMPORTANT] note about running from the clone parent directory (not inside TensorRT-LLM/) to avoid tensorrt_llm.bindings import error Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
Saves the original engine-backend quick start (trtllm-build, inflight_batcher_llm) as docs/README-engine-backend-archive.md so existing users can still find it. The main README now links here from the Legacy section. Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
Remove the TRT-LLM version check from the quick start and switch the clone step to use the upstream repository without a pinned branch. Made-with: Cursor Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
f2d89f6 to
e21c266
Compare
Replace the separate docs/README-engine-backend-archive.md with a "Legacy: TensorRT Engine Backend" section at the bottom of the root README. The archive duplicated most of the current README; the only unique content was the Quick Start (trtllm-build, inflight_batcher_llm model repo setup, config templating, and client examples), which is now preserved inline. TOC and Getting Started link updated to use the in-page anchor. Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
|
My understanding for what's no longer needed for PyTorch/LLM API backend
What's might be relevant Please me if I am wrong. |
… start Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
whoisj
left a comment
There was a problem hiding this comment.
Just a simple, quick formatting review. I'll get to a deeper content review asap.
- Add missing `> ` to NOTE blockquote continuation line - Indent code blocks under bullet points so they render correctly - Add blank line before "For example one could run:" for readability - Left-align table columns and simplify descriptions for readability Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
Move inline comments out of bash blocks as prose and split the cancel example into two separate code blocks for easier copy-paste. Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
|
Hi @whoisj , I've fixed
Let me know if there are other issues! |
|
Correct me if I am wrong. The current TensorRT-LLM tests use |
|
I used Triton and LLMAPI and they worked on H100x2. Is there any command you'd like me to test? |
Addresses reviewer concern that promoting llmapi as "Recommended" is premature without automated CI coverage. Changes: - Rename section from "— Recommended" to "— Simpler Setup" - Remove "Legacy" label from TensorRT Engine Backend sections - Add note that llmapi CI coverage is tracked in issue triton-inference-server#853 - Clarify engine backend note: it has full CI coverage Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
|
Good catch @yinggeh — you are correct that automated CI for the I've updated this PR to address that:
Filed #854 to track adding an |
Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
- Add sub-section quick links under PyTorch Backend ToC entry - Fix top-level TensorRT Engine Backend ToC anchor to #tensorrt-engine-backend-1 - Fix inline redirect anchor to #tensorrt-engine-backend-1 - Remove CI tracking note from PyTorch Backend intro Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
Summary
git clone→ editmodel.yaml→ launchdocs/README-engine-backend-archive.mdand links to it from a short "Legacy" section[!IMPORTANT]callout explaining thetensorrt_llm.bindingsimport error that occurs when launching from inside the cloned repo directory (verified fix: run from the parent ofTensorRT-LLM/)Motivation
The previous README led new users directly into the engine compilation workflow (convert checkpoint →
trtllm-build→ fill config templates), which requires significant setup time and is no longer the recommended path. The PyTorch/LLM API backend is simpler and sufficient for most use cases.Test plan
tritonserver:25.12-trtllm-python-py3andTinyLlama/TinyLlama-1.1B-Chat-v1.0bindingsimport error and fix (run from parent directory)