Feedback about Asynchronous Saving with Distributed Checkpoint (DCP)

Open Beginner friendly
#3,584 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
python, pytorch
Domain
distributed-systems, documentation

Research direction

Open the linked asynchronous checkpoint recipe and inspect the last code block. Compare the checkpoint_future variable with the preceding dcp.async_save usage and confirm the intended assignment from the issue. Done means the example no longer leaves checkpoint_future unwritten and the documentation remains valid.

Written by the indexing model from the issue text.

Description

module: distributed_checkpoint page-feedback

Hey there! Little nitpick about the last block of this docs page: https://docs.pytorch.org/tutorials/recipes/distributed_async_checkpoint_recipe.html

The checkpoint_future variable is never written to in the last block.
Perhaps the intent was to have this instead?

checkpoint_future = dcp.async_save(state_dict, storage_writer=writer, checkpoint_id=f"{CHECKPOINT_DIR}_step{step}")

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

Dominant language
Python
Stars
9.3k
Forks
4.4k
Avg merge
1d 21h
Merged PRs (30d)
4

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pytorch/tutorials

All issues in pytorch/tutorials

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.