Skip to content

fix: nsys multi-report view image from docs.nvidia.com#1466

Merged
terrykong merged 1 commit intomainfrom
nsys-image-fix
Nov 3, 2025
Merged

fix: nsys multi-report view image from docs.nvidia.com#1466
terrykong merged 1 commit intomainfrom
nsys-image-fix

Conversation

@youngeunkwon0405
Copy link
Copy Markdown
Contributor

@youngeunkwon0405 youngeunkwon0405 commented Nov 3, 2025

What does this PR do ?

Fix the image error in https://docs.nvidia.com/nemo/rl/latest/nsys-profiling.html#how-to-analyze-the-end-to-end-rl-loop-all-at-once

image

Issues

List issues that this PR closes (syntax):

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you run the unit tests and functional tests locally? Visit our Testing Guide for how to run tests
  • Did you add or update any necessary documentation? Visit our Document Development Guide for how to write, build and test the docs.

Additional Information

  • ...

Summary by CodeRabbit

  • Documentation
    • Updated image formatting in profiling documentation for improved compatibility and consistency.

Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com>
@youngeunkwon0405 youngeunkwon0405 self-assigned this Nov 3, 2025
@youngeunkwon0405 youngeunkwon0405 requested a review from a team as a code owner November 3, 2025 22:24
@github-actions github-actions Bot added the Documentation Improvements or additions to documentation label Nov 3, 2025
@youngeunkwon0405 youngeunkwon0405 added the CI:docs Run doctest label Nov 3, 2025
@terrykong terrykong added r0.4.0 CI:docs Run doctest and removed CI:docs Run doctest labels Nov 3, 2025
@terrykong terrykong enabled auto-merge (squash) November 3, 2025 22:26
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 3, 2025

📝 Walkthrough

Walkthrough

This pull request replaces HTML img tags with Markdown image syntax in the Nsight profiling documentation file. The change is a documentation formatting update with no functional impact on code or behavior.

Changes

Cohort / File(s) Change Summary
Documentation formatting
docs/nsys-profiling.md
Replaced HTML <img> tags with Markdown image syntax for the Nsight multi-report view image

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • guyueh1
  • parthchadha

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly summarizes the main change: replacing an image in nsys-profiling documentation with the correct source from docs.nvidia.com.
Test Results For Major Changes ✅ Passed This PR contains only a minor documentation change, replacing HTML image tags with Markdown syntax in docs/nsys-profiling.md with no functional impact.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch nsys-image-fix

📜 Recent 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 1f69bb0 and b632837.

📒 Files selected for processing (1)
  • docs/nsys-profiling.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.md

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

When a markdown doc under docs/**/*.md is added or renamed, update docs/index.md to include it in the appropriate section

Files:

  • docs/nsys-profiling.md
⏰ 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). (7)
  • GitHub Check: Docs_Tests
  • GitHub Check: sphinx-build / Build docs
  • GitHub Check: Lint check
  • GitHub Check: Docs_Tests
  • GitHub Check: Lint check
  • GitHub Check: Post submodule check comment / Comment on PR
  • GitHub Check: Post automodel integration comment / Comment on PR
🔇 Additional comments (1)
docs/nsys-profiling.md (1)

103-104: Image asset verified and Markdown syntax is correct.

The replacement of HTML img tags with proper Markdown image syntax is complete and correct. The image file exists at the expected location (docs/assets/nsys-multi-report-view.png), the alt text is descriptive, and the relative path is appropriate for documentation files. No updates to docs/index.md are required since this is a file modification, not a new addition.


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.

@terrykong terrykong merged commit 1982f6e into main Nov 3, 2025
63 of 70 checks passed
@terrykong terrykong deleted the nsys-image-fix branch November 3, 2025 22:33
chtruong814 pushed a commit that referenced this pull request Nov 3, 2025
Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com>
Signed-off-by: NeMo Bot <nemo-bot@nvidia.com>
PrinsYin pushed a commit to PrinsYin/RL that referenced this pull request Nov 30, 2025
)

Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com>
yuanhangsu1986 pushed a commit to yuanhangsu1986/RL-Nemontron-Edge-Omni that referenced this pull request Feb 21, 2026
)

Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com>
Signed-off-by: yuanhangs <yuanhangs@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI:docs Run doctest Documentation Improvements or additions to documentation r0.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants