Skip to content

Commit

Permalink
Fix docstring format (#640)
Browse files Browse the repository at this point in the history
  • Loading branch information
tjruwase committed Jan 5, 2021
1 parent 46d2e28 commit 5ab1279
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions deepspeed/runtime/engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -1236,9 +1236,12 @@ def load_checkpoint(self,
load_module_strict: Optional. Boolean to strictly enforce that the keys in state_dict of module and checkpoint match.
load_optimizer_states: Optional. Boolean to load the training optimizer states from Checkpoint. Ex. ADAM's momentum and variance
load_lr_scheduler_states: Optional. Boolean to add the learning rate scheduler states from Checkpoint.
Return:
load_path: Path of the loaded checkpoint. None if loading the checkpoint failed
client_state: State dictionary used for loading required training states in the client code.
Returns:
A tuple of ``load_path`` and ``client_state``.
*``load_path``: Path of the loaded checkpoint. ``None`` if loading the checkpoint failed.
*``client_state``: State dictionary used for loading required training states in the client code.
"""

if tag is None:
Expand Down

0 comments on commit 5ab1279

Please sign in to comment.