Unverified Commit 5ab12795 authored by Olatunji Ruwase's avatar Olatunji Ruwase Committed by GitHub
Browse files

Fix docstring format (#640)

parent 46d2e287
...@@ -1236,9 +1236,12 @@ class DeepSpeedEngine(Module): ...@@ -1236,9 +1236,12 @@ class DeepSpeedEngine(Module):
load_module_strict: Optional. Boolean to strictly enforce that the keys in state_dict of module and checkpoint match. 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_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. load_lr_scheduler_states: Optional. Boolean to add the learning rate scheduler states from Checkpoint.
Return: Returns:
load_path: Path of the loaded checkpoint. None if loading the checkpoint failed A tuple of ``load_path`` and ``client_state``.
client_state: State dictionary used for loading required training states in the client code.
*``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: if tag is None:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment