From ad3af0aeadcbe0ffb5d15e9d3dba31d2ba03b5dc Mon Sep 17 00:00:00 2001 From: Jane Xu Date: Fri, 28 Jul 2023 08:58:05 -0700 Subject: [PATCH] Change phrasing on optim state hook docs (#106209) Pull Request resolved: https://github.com/pytorch/pytorch/pull/106209 Approved by: https://github.com/albanD --- torch/optim/optimizer.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/torch/optim/optimizer.py b/torch/optim/optimizer.py index daed8095091..b2e524f26f5 100644 --- a/torch/optim/optimizer.py +++ b/torch/optim/optimizer.py @@ -464,7 +464,7 @@ class Optimizer: hook (Callable): The user defined hook to be registered. prepend (bool): If True, the provided pre ``hook`` will be fired before all the already registered pre-hooks on ``state_dict``. Otherwise, - the provided ``hook`` will be fired after all the existing registered + the provided ``hook`` will be fired after all the already registered pre-hooks. (default: False) Returns: @@ -498,8 +498,8 @@ class Optimizer: Args: hook (Callable): The user defined hook to be registered. prepend (bool): If True, the provided post ``hook`` will be fired before - all the existing registered post-hooks on ``state_dict``. Otherwise, - the provided ``hook`` will be fired after all the existing registered + all the already registered post-hooks on ``state_dict``. Otherwise, + the provided ``hook`` will be fired after all the already registered post-hooks. (default: False) Returns: @@ -653,9 +653,9 @@ class Optimizer: Args: hook (Callable): The user defined hook to be registered. prepend (bool): If True, the provided pre ``hook`` will be fired before - all the existing registered pre-hooks on ``load_state_dict``. Otherwise, - the provided ``hook`` will be fired after all the pre-hooks registered - before. (default: False) + all the already registered pre-hooks on ``load_state_dict``. Otherwise, + the provided ``hook`` will be fired after all the already registered + pre-hooks. (default: False) Returns: :class:`torch.utils.hooks.RemoveableHandle`: @@ -688,8 +688,8 @@ class Optimizer: Args: hook (Callable): The user defined hook to be registered. prepend (bool): If True, the provided post ``hook`` will be fired before - all the existing registered post-hooks on ``load_state_dict``. Otherwise, - the provided ``hook`` will be fired after all the existing registered + all the already registered post-hooks on ``load_state_dict``. Otherwise, + the provided ``hook`` will be fired after all the already registered post-hooks. (default: False) Returns: