Skip to content

Commit 9ad495d

Browse files
committed
[skip ci] docs: SAM docstring
1 parent 593e54a commit 9ad495d

File tree

1 file changed

+5
-7
lines changed
  • pytorch_optimizer/optimizer

1 file changed

+5
-7
lines changed

pytorch_optimizer/optimizer/sam.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,11 @@ def closure():
5050
optimizer.step(closure)
5151
optimizer.zero_grad()
5252
53-
Arguments:
54-
55-
params: PARAMETERS. iterable of parameters to optimize or dicts defining parameter groups
56-
base_optimizer: Optimizer. base optimizer
57-
rho: float. size of the neighborhood for computing the max loss
58-
adaptive: bool. element-wise Adaptive SAM
59-
kwargs: Dict. parameters for optimizer.
53+
:param params: PARAMETERS. iterable of parameters to optimize or dicts defining parameter groups
54+
:param base_optimizer: Optimizer. base optimizer
55+
:param rho: float. size of the neighborhood for computing the max loss
56+
:param adaptive: bool. element-wise Adaptive SAM
57+
:param kwargs: Dict. parameters for optimizer.
6058
"""
6159

6260
def __init__(

0 commit comments

Comments
 (0)