Skip to content

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

Draft
DhineshPonnarasan wants to merge 2 commits intoNVIDIA:mainfrom
DhineshPonnarasan:docs/improve-example-docstrings
Draft

Docs: improve docstrings and comments in example training loop#4041
DhineshPonnarasan wants to merge 2 commits intoNVIDIA:mainfrom
DhineshPonnarasan:docs/improve-example-docstrings

Conversation

@DhineshPonnarasan
Copy link
Copy Markdown

@DhineshPonnarasan DhineshPonnarasan commented Mar 27, 2026

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 link
Copy Markdown

copy-pr-bot bot commented Mar 27, 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.

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

2 participants