Skip to content

Commit 0d72c4a

Browse files
committed
address one more issue
1 parent 7ba3ce6 commit 0d72c4a

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

src/plans/stepsize/linesearch.jl

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,11 @@ get_message(::S) where {S <: Stepsize} = ""
2626
"""
2727
initialize_stepsize!(sm::Stepsize)
2828
29-
Initialize the state of a stepsize functor. This is called at the beginning of a solver run,
30-
and can be used to set up internal state of the stepsize functor that is preserved between
31-
line searches in the same optimization, for example adaptive thresholds for Wolfe criteria
32-
in Hager-Zhang line search.
29+
Initialize the state of a stepsize functor. This function should be called in the
30+
`initialize_solver!` function for solvers that do possess a stepsize and can be used to
31+
set up internal state of the stepsize functor that is preserved between line searches in
32+
the same optimization, for example adaptive thresholds for Wolfe criteria in Hager-Zhang
33+
line search.
3334
3435
By default it does nothing.
3536
"""

0 commit comments

Comments
 (0)