Skip to content

Commit 7b59b46

Browse files
committed
docs: SM3 optimizer docstring
1 parent 2d6fe2a commit 7b59b46

File tree

1 file changed

+5
-2
lines changed
  • pytorch_optimizer/optimizer

1 file changed

+5
-2
lines changed

pytorch_optimizer/optimizer/sm3.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@
88
class SM3(Optimizer, BaseOptimizer):
99
r"""Memory-Efficient Adaptive Optimization.
1010
11+
Reference : https://github.com/Enealor/PyTorch-SM3/blob/master/src/SM3/SM3.py
12+
1113
:param params: PARAMETERS. iterable of parameters to optimize or dicts defining parameter groups.
1214
:param lr: float. learning rate.
13-
:param momentum: float.
14-
:param beta: float.
15+
:param momentum: float. coefficient used to scale prior updates before adding. This drastically increases
16+
memory usage if `momentum > 0.0`. This is ignored if the parameter's gradient is sparse.
17+
:param beta: float. coefficient used for exponential moving averages.
1518
"""
1619

1720
def __init__(

0 commit comments

Comments
 (0)