Skip to content

Enhance and fix NVTX for training#3642

Open
yaox12 wants to merge 4 commits intoNVIDIA:mainfrom
yaox12:xiny/use-nvtx-wrapper
Open

Enhance and fix NVTX for training#3642
yaox12 wants to merge 4 commits intoNVIDIA:mainfrom
yaox12:xiny/use-nvtx-wrapper

Conversation

@yaox12
Copy link
Member

@yaox12 yaox12 commented Feb 28, 2026

What does this PR do ?

  1. Always use nvtx_range_push/pop wrappers from core.utils, which is guarded by the flag _nvtx_enabled.
  2. Turn on NVTX range capturing when profiling starts and --nvtx-range is set and turn it off when profiling ends.

Contribution process

flowchart LR
    A[Pre-checks] --> B[PR Tests]
    subgraph Code Review/Approval
        C1[Expert Review] --> C2[Final Review]
    end
    B --> C1
    C2 --> D[Merge]
Loading

Pre-checks

  • I want this PR in a versioned release and have added the appropriate Milestone (e.g., Core 0.8)
  • I have added relevant unit tests
  • I have added relevant functional tests
  • I have added proper typing to my code Typing guidelines
  • I have added relevant documentation
  • I have run the autoformatter.sh on my PR

Code review

The following process is enforced via the CODEOWNERS file for changes into megatron/core. For changes outside of megatron/core, it is up to the PR author whether or not to tag the Final Reviewer team.

For MRs into `main` branch

Feel free to message or comment the @mcore-oncall to help accelerate your merge into main. The less complex your PR is, the faster it will be approved and merged!

(Step 1): Add PR label Expert Review

(Step 2): Collect the expert reviewers reviews

  1. Attach the Expert Review label when your PR is ready for review.
  2. GitHub auto-assigns expert reviewers based on your changes. They will get notified and pick up your PR soon.

⚠️ Only proceed to the next step once all reviewers have approved, merge-conflict are resolved and the CI is passing.
Final Review might get declined if these requirements are not fulfilled.

(Step 3): Final Review

  1. Add Final Review label
  2. GitHub auto-assigns final reviewers based on your changes. They will get notified and pick up your PR soon.

(Optional Step 4): Cherry-pick into release branch

If this PR also needs to be merged into core_r* release branches, after this PR has been merged, select Cherry-pick to open a new PR into the release branch.

For MRs into `dev` branch The proposed review process for `dev` branch is under active discussion.

MRs are mergable after one approval by either eharper@nvidia.com or zijiey@nvidia.com.

Merging your PR

Any member of core-adlr and core-nemo will be able to merge your PR.

Signed-off-by: Xin Yao <xiny@nvidia.com>
Signed-off-by: Xin Yao <xiny@nvidia.com>
@yaox12 yaox12 requested a review from a team as a code owner February 28, 2026 05:23
@yaox12 yaox12 added the Expert Review Apply this label to indicate that your PR is ready for expert review. label Feb 28, 2026
@yaox12 yaox12 requested a review from a team as a code owner February 28, 2026 05:23
@yaox12 yaox12 requested review from a team as code owners February 28, 2026 05:23
@copy-pr-bot
Copy link

copy-pr-bot bot commented Feb 28, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@svcnvidia-nemo-ci svcnvidia-nemo-ci requested a review from a team February 28, 2026 05:23
Signed-off-by: Xin Yao <xiny@nvidia.com>
Signed-off-by: Xin Yao <xiny@nvidia.com>
@@ -755,25 +755,19 @@ def _empty_like_if_meta(tensor: torch.Tensor, *, device: torch.device):

def get_nvtx_range():
Copy link
Member Author

Choose a reason for hiding this comment

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

I'm considering moving this function to core.utils.

def decorator(func: Callable) -> Callable:
if _nvtx_enabled:
if _nvtx_enabled and HAVE_NVTX:
return nvtx.annotate(
Copy link
Member Author

Choose a reason for hiding this comment

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

Also considering replacing this nvtx.annotate with torch.cuda.nvtx.range, so we can remove the direct dependency on nvtx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

complexity: low Expert Review Apply this label to indicate that your PR is ready for expert review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant