Skip to content

Commit 1473f37

Browse files
tuncbkosepkofod
andauthored
Docs: adjust callback function explanation (#1113)
* Docs: adjust callback function explanation * Update docs/src/user/config.md --------- Co-authored-by: Patrick Kofod Mogensen <[email protected]>
1 parent 577fbde commit 1473f37

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/src/user/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ In addition to the solver, you can alter the behavior of the Optim package by us
5252
* `show_warnings`: Should warnings due to NaNs or Inf be shown? Defaults to `true`.
5353
* `trace_simplex`: Include the full simplex in the trace for `NelderMead`. Defaults to `false`.
5454
* `show_every`: Trace output is printed every `show_every`th iteration.
55-
* `callback`: A function to be called during tracing. A return value of `true` stops the `optimize` call. The callback function is called every `show_every`th iteration. If `store_trace` is false, the argument to the callback is of the type [`OptimizationState`](https://github.com/JuliaNLSolvers/Optim.jl/blob/a1035134ca1f3ebe855f1cde034e32683178225a/src/types.jl#L155), describing the state of the current iteration. If `store_trace` is true, the argument is a list of all the states from the first iteration to the current.
55+
* `callback`: A function to be called during tracing. The return value should be a boolean, where `true` will stop the `optimize` call early. The callback function is called every `show_every`th iteration. If `store_trace` is false, the argument to the callback is of the type [`OptimizationState`](https://github.com/JuliaNLSolvers/Optim.jl/blob/a1035134ca1f3ebe855f1cde034e32683178225a/src/types.jl#L155), describing the state of the current iteration. If `store_trace` is true, the argument is a list of all the states from the first iteration to the current.
5656
* `time_limit`: A soft upper limit on the total run time. Defaults to `NaN` (unlimited).
5757

5858
Box constrained optimization has additional keywords to alter the behavior of the outer solver:

0 commit comments

Comments
 (0)