[TRTLLM-6070] docs: Add initial documentation for trtllm-bench CLI. #5734
Conversation
FrankD412
force-pushed
the
fdinatale/trtllm-bench/cli_readme
branch
from
85fa716 to
f54eba2
Compare
FrankD412
changed the title
|
@kaiyux @nv-guomingz -- I built the documentation locally and it renders/is discovered just fine. Do we still run pipelines for doc related PRs? |
|
/bot kill |
|
PR_Github #11183 [ kill ] triggered by Bot |
|
PR_Github #11183 [ kill ] completed with state |
|
/bot run |
|
PR_Github #11188 [ run ] triggered by Bot |
|
PR_Github #11188 [ run ] completed with state |
@FrankD412 You can use |
|
/bot run --stage-list doc |
|
PR_Github #11403 [ run ] triggered by Bot |
|
PR_Github #11403 [ run ] completed with state |
|
/bot run --stage-list doc |
|
PR_Github #11473 [ run ] triggered by Bot |
|
PR_Github #11473 [ run ] completed with state |
|
/bot run --stage-list "A10-Build_Docs" |
|
PR_Github #11482 [ run ] triggered by Bot |
|
@laikhtewari @nv-guomingz @chenopis -- mind giving this a review? |
|
PR_Github #11844 [ reuse-pipeline ] triggered by Bot |
|
PR_Github #11844 [ reuse-pipeline ] completed with state |
WalkthroughA new documentation file for the Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/source/commands/trtllm-bench.rst (3)
6-7: Populate or drop the “Common Options” headerThe heading is currently orphaned with no content. Either enumerate the flags shared by all sub-commands or remove the section to avoid confusing readers.
55-63: Fixlist-tablecell indentationSphinx expects the second cell to be indented two spaces, not five. Current spacing can distort table rendering.
-* - Option - - Description +* - Option + - Description
139-140: Add a terminating periodA full stop after the sentence improves readability.
-Generate synthetic datasets with uniform token distribution +Generate synthetic datasets with uniform token distribution.docs/source/index.rst (1)
80-82: Maintain consistent orderingFor alphabetical (and previous logical) order, consider
trtllm-build,trtllm-bench, thentrtllm-serve.-commands/trtllm-bench -commands/trtllm-build +commands/trtllm-build +commands/trtllm-bench
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/source/commands/trtllm-bench.rst(1 hunks)docs/source/index.rst(1 hunks)
🔇 Additional comments (1)
docs/source/commands/trtllm-bench.rst (1)
10-13: Entry-point verified:tensorrt_llm.commands.bench:mainexists intensorrt_llm/commands/bench.py(line 41), so thesphinx-clickdirective will build correctly.
|
/bot run --stage-list doc |
|
PR_Github #12102 [ run ] triggered by Bot |
|
PR_Github #12102 [ run ] completed with state |
|
/bot run --stage-list "A10-Build_Docs" |
|
PR_Github #12105 [ run ] triggered by Bot |
|
PR_Github #12105 [ run ] completed with state |
|
/bot skip --comment "docs change and pass doc build stage" |
|
PR_Github #12128 [ skip ] triggered by Bot |
|
PR_Github #12128 [ skip ] completed with state |
…VIDIA#5734) Signed-off-by: Frank Di Natale <[email protected]> Signed-off-by: Frank <[email protected]> Co-authored-by: Kaiyu Xie <[email protected]> Signed-off-by: nv-guomingz <[email protected]>
…VIDIA#5734) Signed-off-by: Frank Di Natale <[email protected]> Signed-off-by: Frank <[email protected]> Co-authored-by: Kaiyu Xie <[email protected]>
Description
Adds an initial CLI guide for
trtllm-benchto the documentation.Test Coverage
GitHub Bot Help
/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...Provide a user friendly way for developers to interact with a Jenkins server.
Run
/bot [-h|--help]to print this help message.See details below for each supported subcommand.
run [--disable-fail-fast --skip-test --stage-list "A10-1, xxx" --gpu-type "A30, H100_PCIe" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-[Post-Merge]-1, xxx"]Launch build/test pipelines. All previously running jobs will be killed.
--disable-fail-fast(OPTIONAL) : Disable fail fast on build/tests/infra failures.--skip-test(OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.--stage-list "A10-1, xxx"(OPTIONAL) : Only run the specified test stages. Examples: "A10-1, xxx". Note: Does NOT update GitHub check status.--gpu-type "A30, H100_PCIe"(OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.--only-multi-gpu-test(OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.--disable-multi-gpu-test(OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.--add-multi-gpu-test(OPTIONAL) : Force run the multi-GPU tests. Will also run L0 pre-merge pipeline.--post-merge(OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.--extra-stage "H100_PCIe-[Post-Merge]-1, xxx"(OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-[Post-Merge]-1, xxx".For guidance on mapping tests to stage names, see
docs/source/reference/ci-overview.md.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip testing for latest commit on pull request.
--comment "Reason for skipping build/test"is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.reuse-pipeline
reuse-pipelineReuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.
Summary by CodeRabbit