Skip to content

Commit f4a3745

Browse files
committed
fix make notation more consistent in docs for parameter-free rules
1 parent c78efc2 commit f4a3745

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/optimization/rules.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Depending on the problem, DoWG can be too aggressive and result in unstable beha
1212
If this is suspected, try using DoG instead.
1313
1414
# Parameters
15-
- `alpha`: Scaling factor for initial guess (`repsilon` in the original paper) of the Euclidean distance between the initial point and the optimum. For the initial parameter `x0`, `repsilon` is calculated as `repsilon = alpha*(1 + norm(x0)`. (default value: `1e-6`)
15+
- `alpha`: Scaling factor for initial guess (`repsilon` in the original paper) of the Euclidean distance between the initial point and the optimum. For the initial parameter `lambda0`, `repsilon` is calculated as `repsilon = alpha*(1 + norm(lambda0))`. (default value: `1e-6`)
1616
"""
1717
Optimisers.@def struct DoWG <: Optimisers.AbstractRule
1818
alpha = 1e-6
@@ -41,7 +41,7 @@ DoG works by starting from a AdaGrad-like update rule with a small step size, bu
4141
If `alpha` is too large, the optimzier can initially diverge, while if it is too small, the warm up period can be too long.
4242
4343
# Parameters
44-
- `alpha`: Scaling factor for initial guess (`repsilon` in the original paper) of the Euclidean distance between the initial point and the optimum. For the initial parameter `x0`, `repsilon` is calculated as `repsilon = alpha*(1 + norm(x0)`. (default value: `1e-6`)
44+
- `alpha`: Scaling factor for initial guess (`repsilon` in the original paper) of the Euclidean distance between the initial point and the optimum. For the initial parameter `lambda0`, `repsilon` is calculated as `repsilon = alpha*(1 + norm(lambda0))`. (default value: `1e-6`)
4545
"""
4646
Optimisers.@def struct DoG <: Optimisers.AbstractRule
4747
alpha = 1e-6

0 commit comments

Comments
 (0)