From 4abe38bc9483ebfcd73e8ed4af645a655ca4a9b4 Mon Sep 17 00:00:00 2001 From: Daniel Velkov Date: Tue, 15 Oct 2024 16:40:31 +0000 Subject: [PATCH] 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 --- torch/optim/rmsprop.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/torch/optim/rmsprop.py b/torch/optim/rmsprop.py index f304b7093a6..f839ba0f021 100644 --- a/torch/optim/rmsprop.py +++ b/torch/optim/rmsprop.py @@ -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} \\