Skip to content

docs: add data loading best practices for large-scale training - #4236

Merged
asolergi-nv merged 7 commits into
NVIDIA:mainfrom
sbhavani:docs/best-practices
Apr 22, 2026
Merged

docs: add data loading best practices for large-scale training#4236
asolergi-nv merged 7 commits into
NVIDIA:mainfrom
sbhavani:docs/best-practices

Conversation

@sbhavani

@sbhavani sbhavani commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

What does this PR do ?

Adds a user guide for large-scale data loading that explains cache preparation, startup optimizations, and troubleshooting guidance for training.

⚠️ 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.

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.

sbhavani added 4 commits April 8, 2026 17:30
Add documentation for configuring Megatron data pipeline at 256-512+
node scale, covering index building architecture, cache pre-warming,
and the key flags (--dataloader-fast-cache-load, --dataloader-defer-npy-index-mmap,
--per-dataset-sequences-path). Includes troubleshooting section and
guidance on consolidating small dataset files.
@copy-pr-bot

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

@github-actions

github-actions Bot commented Apr 9, 2026

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.

@svcnvidia-nemo-ci
svcnvidia-nemo-ci marked this pull request as draft April 9, 2026 17:05
@sbhavani
sbhavani requested a review from asolergi-nv April 9, 2026 17:07
@sbhavani
sbhavani marked this pull request as ready for review April 14, 2026 16:36
@svcnvidia-nemo-ci
svcnvidia-nemo-ci requested a review from a team April 14, 2026 16:36
@svcnvidia-nemo-ci svcnvidia-nemo-ci added the docs-only documentation only (docs or docstrings) label Apr 14, 2026

@asolergi-nv asolergi-nv 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.

Thanks!

@asolergi-nv
asolergi-nv enabled auto-merge April 15, 2026 08:34
@sbhavani sbhavani added the Final Review PR is in the "final review" stage label Apr 22, 2026
@asolergi-nv

Copy link
Copy Markdown
Contributor

/ok to test 2c68e70

@svcnvidia-nemo-ci svcnvidia-nemo-ci added this to the Core 0.16 milestone Apr 22, 2026
@asolergi-nv
asolergi-nv added this pull request to the merge queue Apr 22, 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/24787979470

Merged via the queue into NVIDIA:main with commit a6bfe1a Apr 22, 2026
42 checks passed
yangbofun pushed a commit to xlm-research/Megatron-LM that referenced this pull request May 22, 2026
…A#4236)

Co-authored-by: Antoni-Joan Solergibert <asolergibert@nvidia.com>
yhgalaxy pushed a commit to yhgalaxy/Megatron-LM that referenced this pull request Jun 17, 2026
…A#4236)

Co-authored-by: Antoni-Joan Solergibert <asolergibert@nvidia.com>
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
…A#4236)

Co-authored-by: Antoni-Joan Solergibert <asolergibert@nvidia.com>
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
…A#4236)

Co-authored-by: Antoni-Joan Solergibert <asolergibert@nvidia.com>
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) Final Review PR is in the "final review" stage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants