Skip to content

[DCP]Update optimizer.py docstring #94379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wz337 wants to merge 1 commit into from
Closed

[DCP]Update optimizer.py docstring #94379

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions torch/distributed/checkpoint/optimizer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,6 @@ def load_sharded_optimizer_state_dict(
This is the current recommended way to checkpoint is FSDP
>>> # xdoctest: +SKIP
>>> import torch.distributed.checkpoint as dist_cp
>>> import spmd.checkpoint as sp_cp
>>> # Save
>>> model: torch.nn.Model
>>> optim_params = model.parameters()
Expand All @@ -220,7 +219,7 @@ def load_sharded_optimizer_state_dict(
>>> dist_cp.save_state_dict(
>>> state_dict=optim_state,
>>> storage_writer=dist_cp.FileSystemWriter("checkpoint"),
>>> planner=sp_cp.AdvLoadPlanner()
>>> planner=dist_cp.DefaultSavePlanner(),
>>> )
>>>
>>> # Load
Expand All @@ -232,7 +231,7 @@ def load_sharded_optimizer_state_dict(
>>> dist_cp.load_state_dict(
>>> state_dict=checkpoint,
>>> storage_reader=dist_cp.FileSystemReader(checkpoint_file),
>>> planner=sp_cp.AdvLoadPlanner()
>>> planner=dist_cp.DefaultLoadPlanner(),
>>> )
>>> model.load_state_dict(checkpoint["model_state"])
>>>
Expand Down