You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/user/config.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ In addition to the solver, you can alter the behavior of the Optim package by us
47
47
*`f_calls_limit`: A soft upper limit on the number of objective calls. Defaults to `0` (unlimited).
48
48
*`g_calls_limit`: A soft upper limit on the number of gradient calls. Defaults to `0` (unlimited).
49
49
*`h_calls_limit`: A soft upper limit on the number of Hessian calls. Defaults to `0` (unlimited).
50
-
*`allow_f_increases`: Allow steps that increase the objective value. Defaults to `true`. Note that, when this setting is `true`, the last iterate will be returned as the minimizer even if the objective increased.
50
+
*`allow_f_increases`: Allow steps that increase the objective value. Defaults to `true`. Note that, when this setting is `true`, the last iterate will be returned as the minimizer even if the objective increased. This is useful in some methods such as line search based methods with HagerZhang() that allows for a slight increase in the objective function as long as the directional derivative decreases.
51
51
*`successive_f_tol`: Determines the number of times the objective is allowed to increase across iterations. Defaults to 1.
52
52
*`iterations`: How many iterations will run before the algorithm gives up? Defaults to `1_000`.
53
53
*`time_limit`: A soft upper limit on the total run time. Defaults to `NaN` (unlimited).
0 commit comments