From: Tugsbayasgalan (Tugsuu) Manlaibaatar <tmanlaibaatar@fb.com>
Date: Sun, 29 Aug 2021 17:19:56 +0000 (-0700)
Subject: [DOC] improve docstring for Optimizer.state_dict (#63153)
X-Git-Tag: accepted/tizen/8.0/unified/20231005.095509~615
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=52d7dd73987dde6bcfe9c672cfb1b36e284becef;p=platform%2Fupstream%2Fpytorch.git

[DOC] improve docstring for Optimizer.state_dict (#63153)

Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/63153

Fixes: https://github.com/pytorch/pytorch/issues/60121

Test Plan: Imported from OSS

Reviewed By: pbelevich

Differential Revision: D30629462

Pulled By: tugsbayasgalan

fbshipit-source-id: a9160e02ac53bb1a6219879747d73aae9ebe4d2f
---

diff --git a/torch/optim/optimizer.py b/torch/optim/optimizer.py
index 02f1cc2..79f72f0 100644
--- a/torch/optim/optimizer.py
+++ b/torch/optim/optimizer.py
@@ -100,7 +100,8 @@ class Optimizer(object):
 
         * state - a dict holding current optimization state. Its content
             differs between optimizer classes.
-        * param_groups - a dict containing all parameter groups
+        * param_groups - a list containing all parameter groups where each
+            parameter group is a dict
         """
         # Save order indices instead of Tensors
         param_mappings = {}