tutorials icon indicating copy to clipboard operation
tutorials copied to clipboard

[DCP] Add DefaultStager example to distributed async checkpoint recipe

Open niyunsheng opened this issue 1 month ago • 7 comments

Fixes #3710

Description

This PR updates the distributed_async_checkpoint_recipe to include the DefaultStager functionality introduced in PyTorch 2.9.

Motivation: In large-scale training, even with standard async_save, the initial memory copy (Staging phase, GPU -> CPU) occurs on the main thread. This blocks the training loop. This PR introduces DefaultStager, which offloads this copy to a background thread, enabling full computation-communication overlap.

Key Changes:

  1. New Section: Added "Fully Asynchronous Staging with DefaultStager" to the recipe.
  2. Version Note: Added .. versionadded:: 2.9 to indicate version requirements.
  3. Advanced Example: Provided a code example demonstrating how to overlap the D2H copy with the entire Forward and Backward pass:
    • Check staging_completion after backward but before optimizer.step() to ensure data consistency while maximizing parallel execution.
    • Check upload_completion before the next save to manage memory backpressure.
  4. Authors: Added myself to the author list.

Checklist

  • [x] The issue that is being fixed is referred in the description (see above "Fixes #ISSUE_NUMBER")
  • [x] Only one issue is addressed in this pull request
  • [x] Labels from the issue that this PR is fixing are added to this pull request
  • [x] No unnecessary issues are included into this pull request.

cc @LucasLLC @MeetVadakkanchery @mhorowitz @pradeepfn @ekr0 @haochengsong @Saiteja64

niyunsheng avatar Dec 29 '25 13:12 niyunsheng

:link: Helpful Links

:test_tube: See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3711

Note: Links to docs will display an error until the docs builds have been completed.

:white_check_mark: No Failures

As of commit b6ec6eab0450407390ca8388060b73ba39a8e6de with merge base b863c3bac9e09121678b9cd864fc428cbefbfea3 (image): :green_heart: Looks good so far! There are no failures yet. :green_heart:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

pytorch-bot[bot] avatar Dec 29 '25 13:12 pytorch-bot[bot]

Hi @niyunsheng!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

meta-cla[bot] avatar Dec 29 '25 13:12 meta-cla[bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

meta-cla[bot] avatar Dec 29 '25 14:12 meta-cla[bot]

Hi @LucasLLC, gentle ping on this.

Just to clarify context: This tutorial covers an existing feature (DefaultStager) and is independent of my other open PRs. It does not require any upstream changes.

It has been passing CI for two weeks. Could you please take a look when you have a moment? Thanks!

niyunsheng avatar Jan 13 '26 15:01 niyunsheng

Preview link: https://docs-preview.pytorch.org/pytorch/tutorials/3711/recipes/distributed_async_checkpoint_recipe.html

AlannaBurke avatar Jan 14 '26 02:01 AlannaBurke

Hi @AlannaBurke , thanks for the review!

I've applied your grammar and other suggestions.

Extra Fix: While previewing the file locally (make html-noplot), I noticed another small display issue in this file that was missing from the review, so I went ahead and fixed that as well.

The file should be perfect now. Ready for another look!

niyunsheng avatar Jan 14 '26 03:01 niyunsheng

Thanks @LucasLLC for the approval!

@AlannaBurke I've pushed a fix for the remaining lint/whitespace errors. Since I'm an external contributor, could you please approve the CI workflows to run?

Once the checks are green, this should be ready to land. Thanks!

niyunsheng avatar Jan 14 '26 23:01 niyunsheng

"Hi @AlannaBurke @LucasLLC,

I've just synced this branch with main to ensure everything is up-to-date.

Could you please help approve the CI workflows to run? Once the checks pass, this should be ready to merge. Thanks!

niyunsheng avatar Jan 19 '26 23:01 niyunsheng