Skip to content

Conversation

@yechank-nvidia
Copy link
Collaborator

@yechank-nvidia yechank-nvidia commented Sep 30, 2025

Summary by CodeRabbit

  • Documentation
    • Added a clear note clarifying supported EXAONE models and their corresponding runtime flows, with links to detailed sections.
    • Restored and expanded usage guidance for EXAONE-3.0, EXAONE-Deep, and EXAONE-4.0 to aid setup and usage.
    • Replaced placeholder quantization output examples with real sample outputs for multiple prompts, improving clarity and expectations.
    • Enhanced overall readability and navigation of the README for quicker onboarding and more accurate model usage.

Signed-off-by: yechank <161688079+yechank-nvidia@users.noreply.github.com>
@yechank-nvidia yechank-nvidia requested review from a team as code owners September 30, 2025 06:41
@yechank-nvidia yechank-nvidia self-assigned this Sep 30, 2025
@yechank-nvidia yechank-nvidia changed the title Add more description on EXAONE usage [None][doc] Add more description on EXAONE usage Sep 30, 2025
@yechank-nvidia
Copy link
Collaborator Author

/bot run --stage-list "A10-Build_Docs"

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 30, 2025

📝 Walkthrough

Walkthrough

Documentation updates to EXAONE README: added a note clarifying model-to-flow mappings, restored and expanded usage guidance per model, and replaced placeholder quantization outputs with concrete sample outputs for multiple prompts.

Changes

Cohort / File(s) Summary of changes
Docs: EXAONE README updates
examples/models/core/exaone/README.md
Added note on flow mappings (TRT vs PyTorch) per model; reinstated and expanded usage guidance for EXAONE-3.0, EXAONE-Deep, EXAONE-4.0; replaced placeholder under PyTorch flow quantization with concrete sample outputs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request lacks any description content and does not follow the required template sections such as “## Description” and “## Test Coverage,” so reviewers cannot understand the purpose, scope, or testing of the changes. Please add a complete description using the provided template by including a “## Description” section that explains the issue and solution, a “## Test Coverage” section listing relevant tests, and ensure the PR checklist is addressed.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The title concisely summarizes the primary change—adding documentation details to the EXAONE example—making it clear to reviewers that the update focuses on improving example descriptions.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
examples/models/core/exaone/README.md (2)

16-16: Fix formatting inconsistency in table of contents.

Missing space after the dash before the bracket.

Apply this diff:

-        -[PyTorch flow Quantization](#pytorch-flow-quantization)
+        - [PyTorch flow Quantization](#pytorch-flow-quantization)

62-62: Fix typo in documentation.

"Download he" should be "Download the".

Apply this diff:

-Download he HuggingFace checkpoints of EXAONE-4.0 model. Here, we only use the `EXAONE-4.0-32B` model for the example. From EXAONE-4.0 model, we support only on PyTorch flow.
+Download the HuggingFace checkpoints of EXAONE-4.0 model. Here, we only use the `EXAONE-4.0-32B` model for the example. From EXAONE-4.0 model, we support only on PyTorch flow.
🧹 Nitpick comments (1)
examples/models/core/exaone/README.md (1)

69-69: Maintain consistent capitalization.

For consistency with the rest of the document, use "PyTorch" with capital T.

Apply this diff:

-### Pytorch flow
+### PyTorch flow
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 948b8b9 and d6432ef.

📒 Files selected for processing (1)
  • examples/models/core/exaone/README.md (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Pre-commit Check
🔇 Additional comments (2)
examples/models/core/exaone/README.md (2)

35-40: LGTM! Clear guidance on model-to-flow mappings.

The added note effectively clarifies which EXAONE model variants should use which flow (TRT vs PyTorch), helping users quickly understand the correct approach for their specific model. The structure and formatting are appropriate for documentation.


81-83: Concrete examples improve documentation clarity.

The replacement of placeholder output with actual sample generations for multiple prompts helps users understand what to expect from the model. The outputs are realistic and properly formatted.

@tensorrt-cicd
Copy link
Collaborator

PR_Github #20339 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #20339 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #15343 (Partly Tested) completed with status: 'SUCCESS'

Copy link
Collaborator

@brb-nv brb-nv left a comment

Choose a reason for hiding this comment

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

LGTM

@yechank-nvidia yechank-nvidia enabled auto-merge (squash) October 1, 2025 00:47
@yechank-nvidia yechank-nvidia changed the title [None][doc] Add more description on EXAONE usage [None][doc] Add more description on EXAONE example Oct 1, 2025
@yechank-nvidia
Copy link
Collaborator Author

/bot skip --comment "doc changes"

@tensorrt-cicd
Copy link
Collaborator

PR_Github #20432 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #20432 [ skip ] completed with state SUCCESS
Skipping testing for commit d6432ef

@yechank-nvidia yechank-nvidia merged commit e9e4632 into NVIDIA:main Oct 1, 2025
10 of 13 checks passed
faradawn pushed a commit to faradawn/TensorRT-LLM that referenced this pull request Oct 2, 2025
Signed-off-by: yechank <161688079+yechank-nvidia@users.noreply.github.com>
Signed-off-by: Faradawn Yang <faradawny@gmail.com>
evezhier pushed a commit to evezhier/TensorRT-LLM that referenced this pull request Oct 3, 2025
Signed-off-by: yechank <161688079+yechank-nvidia@users.noreply.github.com>
faradawn pushed a commit to faradawn/TensorRT-LLM that referenced this pull request Oct 3, 2025
Signed-off-by: yechank <161688079+yechank-nvidia@users.noreply.github.com>
Signed-off-by: Faradawn Yang <faradawny@gmail.com>
dominicshanshan pushed a commit to dominicshanshan/TensorRT-LLM that referenced this pull request Nov 1, 2025
Signed-off-by: yechank <161688079+yechank-nvidia@users.noreply.github.com>
dominicshanshan pushed a commit to dominicshanshan/TensorRT-LLM that referenced this pull request Nov 3, 2025
Signed-off-by: yechank <161688079+yechank-nvidia@users.noreply.github.com>
dominicshanshan pushed a commit to dominicshanshan/TensorRT-LLM that referenced this pull request Nov 3, 2025
Signed-off-by: yechank <161688079+yechank-nvidia@users.noreply.github.com>
dominicshanshan pushed a commit to dominicshanshan/TensorRT-LLM that referenced this pull request Nov 3, 2025
Signed-off-by: yechank <161688079+yechank-nvidia@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants