Skip to content

Commit f43a8c3

Browse files
committed
[skip ci] docs: SAM docstring
1 parent 9ad5ee3 commit f43a8c3

File tree

1 file changed

+8
-6
lines changed
  • pytorch_optimizer/optimizer

1 file changed

+8
-6
lines changed

pytorch_optimizer/optimizer/sam.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
class SAM(Optimizer, BaseOptimizer):
1212
r"""Sharpness-Aware Minimization for Efficiently Improving Generalization
1313
14-
Example :
14+
Example:
1515
from pytorch_optimizer import SAM
1616
...
1717
model = YourModel()
@@ -50,11 +50,13 @@ def closure():
5050
optimizer.step(closure)
5151
optimizer.zero_grad()
5252
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.
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.
5860
"""
5961

6062
def __init__(

0 commit comments

Comments
 (0)