From 5ab12795958dff0b56d3faf7421abe9cad7bcba1 Mon Sep 17 00:00:00 2001 From: Olatunji Ruwase Date: Tue, 5 Jan 2021 13:55:21 -0800 Subject: [PATCH] Fix docstring format (#640) --- deepspeed/runtime/engine.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/deepspeed/runtime/engine.py b/deepspeed/runtime/engine.py index 99db78ec6dc5..27ce1c7439fc 100755 --- a/deepspeed/runtime/engine.py +++ b/deepspeed/runtime/engine.py @@ -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: