Skip to content

Docs: improve docstrings and comments in example training loop - #4041

Merged
Phlip79 merged 7 commits into
NVIDIA:mainfrom
DhineshPonnarasan:docs/improve-example-docstrings
Apr 17, 2026
Merged

Phlip79 merged 7 commits into
NVIDIA:mainfrom
DhineshPonnarasan:docs/improve-example-docstrings

Conversation

@DhineshPonnarasan

@DhineshPonnarasan DhineshPonnarasan commented Mar 27, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Improved docstrings and inline comments in examples/run_simple_mcore_train_loop.py to enhance clarity and usability.

Changes

  • Added and refined function docstrings
  • Clarified arguments and return values
  • Added minimal inline comments for non-obvious logic

Notes

  • No code logic or functionality was changed
  • Formatting and style follow project conventions

closes #4040


@sbhavani Could you please review this PR and help trigger the CI?
This PR focuses on improving documentation clarity with no functional changes. Happy to make any adjustments based on feedback. Thanks

@copy-pr-bot

copy-pr-bot Bot commented Mar 27, 2026

Copy link
Copy Markdown

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.

@DhineshPonnarasan
DhineshPonnarasan marked this pull request as ready for review April 2, 2026 21:03
@svcnvidia-nemo-ci
svcnvidia-nemo-ci requested a review from a team April 2, 2026 21:03
@Phlip79

Phlip79 commented Apr 4, 2026

Copy link
Copy Markdown
Member

/ok to test d59eedb

@svcnvidia-nemo-ci svcnvidia-nemo-ci added this to the Core 0.16 milestone Apr 4, 2026
@Phlip79

Phlip79 commented Apr 4, 2026

Copy link
Copy Markdown
Member

/claude review

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@Phlip79
Phlip79 enabled auto-merge April 4, 2026 01:00
@chtruong814 chtruong814 added the needs-follow-up Issue needs follow-up label Apr 6, 2026
@Phlip79

Phlip79 commented Apr 7, 2026

Copy link
Copy Markdown
Member

/ok to test 81d078e

@Phlip79
Phlip79 added this pull request to the merge queue Apr 7, 2026
@svcnvidia-nemo-ci

Copy link
Copy Markdown
Contributor

🔄 Merge queue validation started!

You can track the progress here: https://github.com/NVIDIA/Megatron-LM/actions/runs/24068346517

@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Apr 7, 2026
@gautham-kollu

Copy link
Copy Markdown
Contributor

/ok to test a642eca

@chtruong814 chtruong814 added needs-follow-up Issue needs follow-up and removed needs-follow-up Issue needs follow-up labels Apr 8, 2026
@Phlip79

Phlip79 commented Apr 17, 2026

Copy link
Copy Markdown
Member

/ok to test 7b74109

@Phlip79
Phlip79 enabled auto-merge April 17, 2026 16:45
@Phlip79
Phlip79 added this pull request to the merge queue Apr 17, 2026
@svcnvidia-nemo-ci

Copy link
Copy Markdown
Contributor

🔄 Merge queue validation started!

You can track the progress here: https://github.com/NVIDIA/Megatron-LM/actions/runs/24590615101

@svcnvidia-nemo-ci

Copy link
Copy Markdown
Contributor

🔄 Merge queue validation started!

You can track the progress here: https://github.com/NVIDIA/Megatron-LM/actions/runs/24590853768

Merged via the queue into NVIDIA:main with commit 75a2878 Apr 17, 2026
61 checks passed
@chtruong814 chtruong814 removed the needs-follow-up Issue needs follow-up label Apr 18, 2026
Victarry pushed a commit to yanring/Megatron-LM that referenced this pull request Apr 20, 2026
* origin/main: (286 commits)
  Rename MambaModel/MambaStack to HybridModel/HybridStack (NVIDIA#4099)
  Fix Megatron initialization with extra_args_provider (NVIDIA#4327)
  Fix RL to once again work with --skip-train (NVIDIA#4249)
  Add activation logging and tokens per expert logging (NVIDIA#3842)
  Make param_index_map always use unpacked (full numel) offsets (NVIDIA#4328)
  FA4 Inference (NVIDIA#4186)
  Fix RL reward due to stop token (NVIDIA#4096)
  cp: Fix UT timeout (NVIDIA#4310) (NVIDIA#4373)
  feat(ckpt): add --async-ckpt-use-cpu-shm argument (NVIDIA#4355)
  Update copy-pr-bot.yaml [skip ci]
  Docs: improve docstrings and comments in example training loop (NVIDIA#4041)
  Add QK layernorm support for dot-product attention in MambaModel (NVIDIA#4067)
  Fix bug with non-partial rollouts (NVIDIA#3964)
  [docs] ci: use parent-relative json_url for version picker (NVIDIA#4367)
  Add tables and histogram for RL staleness (NVIDIA#4097)
  Port DeepSeek Sparse Attention to `MambaModel` (NVIDIA#3553)
  docs: bump versions1.json to 0.17.0 (latest) (NVIDIA#4360)
  Fix potential coredump issue that occurs when saving a checkpoint (NVIDIA#1871)
  ci(gb200): add 1-node mr-github functional test variants (NVIDIA#4334)
  fix: wait for async P2P send before deallocating output tensor (NVIDIA#4047)
  ...

# Conflicts:
#	megatron/core/transformer/cuda_graphs.py
yangbofun pushed a commit to xlm-research/Megatron-LM that referenced this pull request May 22, 2026
yhgalaxy pushed a commit to yhgalaxy/Megatron-LM that referenced this pull request Jun 17, 2026
jon-barker pushed a commit to jon-barker/Megatron-LM that referenced this pull request Jul 10, 2026
…A#4041)

Signed-off-by: Jon Barker <jbarker@aws-cmh-slurm-1-vscode-02.cm.cluster>
terminator123 pushed a commit to 021ai/Megatron-LM that referenced this pull request Aug 3, 2026

This branch was previously deployed

1 inactive deployment
test — 7b741096 Deployed Apr 17, 2026 by copy-pr-bot[bot] via cicd-wait-in-queue #11722
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve docstrings and inline comments in example scripts

6 participants