RMSprop docs: add missing input "epsilon" (#137854)

Adding a missing input argument in the docs for RMSprop. Like in the doc for AdamW https://pytorch.org/docs/stable/generated/torch.optim.AdamW.html

Pull Request resolved: https://github.com/pytorch/pytorch/pull/137854
Approved by: https://github.com/janeyx99
This commit is contained in:
Daniel Velkov 2024-10-15 16:40:31 +00:00 committed by PyTorch MergeBot
parent 822aa588bc
commit 4abe38bc94

View file

@ -202,9 +202,10 @@ RMSprop.__doc__ = (
.. math::
\begin{aligned}
&\rule{110mm}{0.4pt} \\
&\textbf{input} : \alpha \text{ (alpha)},\: \gamma \text{ (lr)},
&\textbf{input} : \alpha \text{ (alpha)}, \: \gamma \text{ (lr)},
\: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)} \\
&\hspace{13mm} \lambda \text{ (weight decay)},\: \mu \text{ (momentum)},\: centered\\
&\hspace{13mm} \lambda \text{ (weight decay)},\: \mu \text{ (momentum)},
\: centered, \: \epsilon \text{ (epsilon)} \\
&\textbf{initialize} : v_0 \leftarrow 0 \text{ (square average)}, \:
\textbf{b}_0 \leftarrow 0 \text{ (buffer)}, \: g^{ave}_0 \leftarrow 0 \\[-1.ex]
&\rule{110mm}{0.4pt} \\