Skip to content

Commit 768e124

Browse files
committed
Fix typos and extend doc string for CG.
1 parent 07344fb commit 768e124

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

src/plans/conjugate_gradient_plan.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The following fields from above <re keyword arguments
5252
$(_var(:Keyword, :X, "initial_gradient"))
5353
$(_var(:Keyword, :p; add = :as_Initial))
5454
* `coefficient=[`ConjugateDescentCoefficient`](@ref)`()`: specify a CG coefficient, see also the [`ManifoldDefaultsFactory`](@ref).
55-
* `restart_condition=[`NeverRestart`](@ref)`()`: specify a [restart condition](@ref cg-restart). It defaults to never restart.
55+
* `restart_condition=`[`NeverRestart`](@ref)`()`: specify a [restart condition](@ref cg-restart). It defaults to never restart.
5656
$(_var(:Keyword, :stepsize; default = "[`default_stepsize`](@ref)`(M, ConjugateGradientDescentState; retraction_method=retraction_method)`"))
5757
$(_var(:Keyword, :stopping_criterion; default = "[`StopAfterIteration`](@ref)`(500)`$(_sc(:Any))[`StopWhenGradientNormLess`](@ref)`(1e-8)`)"))
5858
$(_var(:Keyword, :retraction_method))

src/solvers/conjugate_gradient_descent.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ $(_var(:Argument, :p))
8383
rule to compute the descent direction update coefficient ``β_k``, as a functor, where
8484
the resulting function maps are `(amp, cgs, k) -> β` with `amp` an [`AbstractManoptProblem`](@ref),
8585
`cgs` is the [`ConjugateGradientDescentState`](@ref), and `k` is the current iterate.
86-
* `restart_condition::AbstractRestartCondition=`[`NeverRestart`]`)(@ref)`()`:
86+
* `restart_condition::AbstractRestartCondition=`[`NeverRestart`](@ref)`()`:
8787
rule when the algorithm should restart, i.e. use the negative gradient instead of the computed direction,
8888
as a functior where the resulting function maps are `(amp, cgs, k) -> corr::Bool` with `amp` an [`AbstractManoptProblem`](@ref),
8989
`cgs` is the [`ConjugateGradientDescentState`](@ref), and `k` is the current iterate.
@@ -97,6 +97,8 @@ $(_var(:Keyword, :vector_transport_method))
9797
If you provide the [`ManifoldFirstOrderObjective`](@ref) directly, the `evaluation=` keyword is ignored.
9898
The decorations are still applied to the objective.
9999
100+
$(_note(:OtherKeywords))
101+
100102
$(_note(:OutputSection))
101103
"""
102104

0 commit comments

Comments
 (0)