Skip to content

Skills for running unit tests and working with slurm - #4502

Merged
yashaswikarnati merged 2 commits into
NVIDIA:mainfrom
yashaswikarnati:docs-skills-NMFW-451-megatron-lm-skills
Apr 29, 2026
Merged

Skills for running unit tests and working with slurm#4502
yashaswikarnati merged 2 commits into
NVIDIA:mainfrom
yashaswikarnati:docs-skills-NMFW-451-megatron-lm-skills

Conversation

@yashaswikarnati

Copy link
Copy Markdown
Contributor

What does this PR do ?

⚠️ For major changes (either in lines of code or in its impact), please make sure to first share a design doc with the team. If you're unsure what's the best way to do so, contact the @mcore-oncall.

Issue tracking

For PRs from open-source community contributors:

  • New features: a linked issue is required. Please open a feature request and reference it here before submitting the PR.
  • Small updates (bug fixes, minor improvements): a linked issue is recommended and will accelerate the PR review process.

Linked issue:

Contribution process

Pre-checks

  • 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

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!

All PRs start as draft. If you open a non-draft PR, it will be automatically converted to draft.

Step 1: Mark PR as "Ready for Review"

  1. When your PR is ready, click Ready for Review.
  2. An oncall reviewer is auto-assigned and expert reviewers are notified based on your changes.
    • Some PRs may jump straight to step 2. This is determined by .github/CODEOWNERS.

⚠️ Only mark as ready once merge-conflicts are resolved and the CI is passing.
Final Review might get declined if these requirements are not fulfilled.

Step 2: Final Review

For PRs that change megatron/core, once all expert reviewers have approved, the Final Review label is applied automatically and final reviewers are assigned.

For PRs outside megatron/core, this step is skipped.

Step 3: Approved

Once all required reviewers have approved, the Approved label is applied automatically.

Merge

Any member of mcore-engineers will be able to merge your PR.

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.

@copy-pr-bot

copy-pr-bot Bot commented Apr 28, 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.

@svcnvidia-nemo-ci
svcnvidia-nemo-ci marked this pull request as draft April 28, 2026 18:59
@github-actions

Copy link
Copy Markdown
Contributor

This PR has been automatically converted to draft because all PRs must start as drafts.

When you are ready for review, click Ready for Review to begin the review process. This will:

  1. Add the oncall reviewer (optional reviewer)
  2. Add required review teams based on your changes

See the contribution guide for more details.

@yashaswikarnati
yashaswikarnati marked this pull request as ready for review April 28, 2026 18:59
@svcnvidia-nemo-ci
svcnvidia-nemo-ci requested a review from a team April 28, 2026 18:59
@svcnvidia-nemo-ci svcnvidia-nemo-ci added the docs-only documentation only (docs or docstrings) label Apr 28, 2026

@Phlip79 Phlip79 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

  • skills/running-unit-tests-in-megatron-lm.md: has a lot of overlap with the existing skills/testsystem/SKILL.md. I think the best solution is to update the existing skill.
  • skills/running-on-slurm.md: can you conform to the rest of the skills with the naming please? Also, can you just name it slurm?

Two new skills documenting how to run Megatron-LM unit tests and how to
launch distributed training on a SLURM cluster.

run-unit-tests covers environment setup with `uv sync --extra training
--extra dev`, the fact that all unit tests initialize a torch
distributed group and must be launched through `torch.distributed.run`,
single-test and marker-filtered invocations, the CI bucket runner, and
common gotchas around the default pytest addopts and per-rank stdout
interleaving.

run-on-slurm covers a minimal sbatch skeleton, `MASTER_ADDR` /
`MASTER_PORT` / `WORLD_SIZE` / `NODE_RANK` setup, the conditional rules
for `CUDA_DEVICE_MAX_CONNECTIONS` (pre-Blackwell vs Blackwell, FSDP,
`overlap_moe_expert_parallel_comm`), container conventions,
`squeue`/`sacct`/`scancel`, and per-rank failure diagnosis.

Both follow the existing skills/ convention: a directory per skill with
a SKILL.md file and the standard frontmatter (name, description,
TRIGGER when, DO NOT TRIGGER when).
@yashaswikarnati
yashaswikarnati force-pushed the docs-skills-NMFW-451-megatron-lm-skills branch from 485ac83 to 31f3634 Compare April 28, 2026 22:29

@Phlip79 Phlip79 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please rename testsystem to ci-test-system and update the contents of that skill accordingly.

The existing testsystem skill covers CI pipelines, recipe YAMLs, and
test-failure investigation. With the new run-unit-tests skill landing
alongside it, the unqualified name "testsystem" is easy to confuse
with "system for running tests." Rename to ci-test-system, which
matches the actual scope, and update every cross-reference:

- skills/ci-test-system/SKILL.md: name field
- skills/build-and-dependency/SKILL.md: DO NOT TRIGGER cross-reference
- skills/run-unit-tests/SKILL.md: DO NOT TRIGGER cross-reference
- skills/run-on-slurm/SKILL.md: DO NOT TRIGGER cross-reference

The body of ci-test-system/SKILL.md does not reference its own name,
so no further edits inside that file.
@yashaswikarnati

Copy link
Copy Markdown
Contributor Author

/ok to test 928c14c

@yashaswikarnati
yashaswikarnati added this pull request to the merge queue Apr 29, 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/25135414691

@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/25136313569

Merged via the queue into NVIDIA:main with commit cfee04e Apr 29, 2026
41 checks passed
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
Signed-off-by: yhgalaxy <yhgalaxy@outlook.com>
jon-barker pushed a commit to jon-barker/Megatron-LM that referenced this pull request Jul 10, 2026
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-only documentation only (docs or docstrings)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants