/
Manopt.jl
564 lines (549 loc) · 17.5 KB
/
Manopt.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
@doc raw"""
🏔️ Manopt.jl: optimization on Manifolds in Julia.
* 📚 Documentation: [manoptjl.org](https://manoptjl.org)
* 📦 Repository: [github.com/JuliaManifolds/Manopt.jl](https://github.com/JuliaManifolds/Manopt.jl)
* 💬 Discussions: [github.com/JuliaManifolds/Manopt.jl/discussions](https://github.com/JuliaManifolds/Manopt.jl/discussions)
* 🎯 Issues: [github.com/JuliaManifolds/Manopt.jl/issues](https://github.com/JuliaManifolds/Manopt.jl/issues)
"""
module Manopt
import Base: &, copy, getindex, identity, setindex!, show, |
import LinearAlgebra: reflect!
import ManifoldsBase: embed!
using ColorSchemes
using ColorTypes
using Colors
using DataStructures: CircularBuffer, capacity, length, push!, size, isfull
using Dates: Millisecond, Nanosecond, Period, canonicalize, value
using LinearAlgebra:
cond,
Diagonal,
I,
Eigen,
eigen,
eigen!,
eigvals,
tril,
Symmetric,
dot,
cholesky,
eigmin,
opnorm,
mul!
using ManifoldDiff:
adjoint_differential_log_argument,
adjoint_differential_log_argument!,
differential_exp_argument,
differential_exp_argument!,
differential_exp_basepoint,
differential_exp_basepoint!,
differential_log_argument,
differential_log_argument!,
differential_log_basepoint,
differential_log_basepoint!,
differential_shortest_geodesic_endpoint,
differential_shortest_geodesic_endpoint!,
differential_shortest_geodesic_startpoint,
differential_shortest_geodesic_startpoint!,
jacobi_field,
jacobi_field!,
riemannian_gradient,
riemannian_gradient!,
riemannian_Hessian,
riemannian_Hessian!
using ManifoldsBase:
AbstractBasis,
AbstractDecoratorManifold,
AbstractInverseRetractionMethod,
AbstractManifold,
AbstractPowerManifold,
AbstractRetractionMethod,
AbstractVectorTransportMethod,
CachedBasis,
DefaultManifold,
DefaultOrthonormalBasis,
DiagonalizingOrthonormalBasis,
ExponentialRetraction,
LogarithmicInverseRetraction,
NestedPowerRepresentation,
ParallelTransport,
PowerManifold,
ProductManifold,
ProjectionTransport,
QRRetraction,
TangentSpace,
^,
_read,
_write,
allocate,
allocate_result,
allocate_result_type,
base_manifold,
copy,
copyto!,
default_inverse_retraction_method,
default_retraction_method,
default_vector_transport_method,
distance,
embed,
embed_project,
embed_project!,
exp,
exp!,
geodesic,
get_basis,
get_component,
get_coordinates,
get_coordinates!,
get_embedding,
get_iterator,
get_vector,
get_vector!,
get_vectors,
injectivity_radius,
inner,
inverse_retract,
inverse_retract!,
is_flat,
is_point,
is_vector,
log,
log!,
manifold_dimension,
mid_point,
mid_point!,
norm,
number_eltype,
number_of_coordinates,
power_dimensions,
project,
project!,
rand!,
riemann_tensor,
riemann_tensor!,
representation_size,
requires_caching,
retract,
retract!,
sectional_curvature,
set_component!,
shortest_geodesic,
shortest_geodesic!,
submanifold_components,
vector_transport_to,
vector_transport_to!,
zero_vector,
zero_vector!,
×,
ℂ,
ℝ
using Markdown
using Preferences:
@load_preference, @set_preferences!, @has_preference, @delete_preferences!
using Printf
using Random: AbstractRNG, default_rng, shuffle!, rand, randn!, randperm
using Requires
using SparseArrays
using Statistics: cor, cov, mean, median, std
include("plans/plan.jl")
# solvers general framework
include("solvers/solver.jl")
# specific solvers
include("solvers/adaptive_regularization_with_cubics.jl")
include("solvers/alternating_gradient_descent.jl")
include("solvers/augmented_Lagrangian_method.jl")
include("solvers/convex_bundle_method.jl")
include("solvers/ChambollePock.jl")
include("solvers/cma_es.jl")
include("solvers/conjugate_gradient_descent.jl")
include("solvers/cyclic_proximal_point.jl")
include("solvers/difference_of_convex_algorithm.jl")
include("solvers/difference-of-convex-proximal-point.jl")
include("solvers/DouglasRachford.jl")
include("solvers/exact_penalty_method.jl")
include("solvers/Lanczos.jl")
include("solvers/NelderMead.jl")
include("solvers/FrankWolfe.jl")
include("solvers/gradient_descent.jl")
include("solvers/LevenbergMarquardt.jl")
include("solvers/particle_swarm.jl")
include("solvers/primal_dual_semismooth_Newton.jl")
include("solvers/proximal_bundle_method.jl")
include("solvers/quasi_Newton.jl")
include("solvers/truncated_conjugate_gradient_descent.jl")
include("solvers/trust_regions.jl")
include("solvers/stochastic_gradient_descent.jl")
include("solvers/subgradient.jl")
include("solvers/debug_solver.jl")
include("solvers/record_solver.jl")
include("helpers/checks.jl")
include("helpers/exports/Asymptote.jl")
include("helpers/LineSearchesTypes.jl")
include("deprecated.jl")
"""
Manopt.JuMP_Optimizer()
Creates a new optimizer object for the [MathOptInterface](https://jump.dev/MathOptInterface.jl/) (MOI).
An alias `Manopt.JuMP_Optimizer` is defined for convenience.
The minimization of a function `f(X)` of an array `X[1:n1,1:n2,...]`
over a manifold `M` starting at `X0`, can be modeled as follows:
```julia
using JuMP
model = Model(Manopt.JuMP_Optimizer)
@variable(model, X[i1=1:n1,i2=1:n2,...] in M, start = X0[i1,i2,...])
@objective(model, Min, f(X))
```
The optimizer assumes that `M` has a `Array` shape described
by `ManifoldsBase.representation_size`.
"""
global JuMP_Optimizer
"""
struct VectorizedManifold{M} <: MOI.AbstractVectorSet
manifold::M
end
Representation of points of `manifold` as a vector of `R^n` where `n` is
`MOI.dimension(VectorizedManifold(manifold))`.
"""
global JuMP_VectorizedManifold
"""
struct ArrayShape{N} <: JuMP.AbstractShape
Shape of an `Array{T,N}` of size `size`.
"""
global JuMP_ArrayShape
function __init__()
#
# Error Hints
#
@static if isdefined(Base.Experimental, :register_error_hint)
Base.Experimental.register_error_hint(MethodError) do io, exc, argtypes, kwargs
if exc.f === convex_bundle_method_subsolver
print(
io,
"\nThe `convex_bundle_method_subsolver` has to be implemented. A default is available currently when loading QuadraticModels.jl and RipQP.jl. That is\n",
)
printstyled(io, "`using QuadraticModels, RipQP`"; color=:cyan)
end
if exc.f === proximal_bundle_method_subsolver
print(
io,
"\nThe `proximal_bundle_method_subsolver` has to be implemented. A default is available currently when loading QuadraticModels.jl and RipQP.jl. That is\n",
)
printstyled(io, "`using QuadraticModels, RipQP`"; color=:cyan)
end
end
end
#
# Requires fallback for Julia < 1.9
#
@static if !isdefined(Base, :get_extension)
@require JuMP = "4076af6c-e467-56ae-b986-b466b2749572" begin
include("../ext/ManoptJuMPExt.jl")
end
@require Manifolds = "1cead3c2-87b3-11e9-0ccd-23c62b72b94e" begin
include("../ext/ManoptManifoldsExt/ManoptManifoldsExt.jl")
end
@require Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" begin
include("../ext/ManoptPlotsExt/ManoptPlotsExt.jl")
end
@require LineSearches = "d3d80556-e9d4-5f37-9878-2ab0fcc64255" begin
include("../ext/ManoptLineSearchesExt.jl")
end
@require LRUCache = "8ac3fa9e-de4c-5943-b1dc-09c6b5f20637" begin
include("../ext/ManoptLRUCacheExt.jl")
end
@require QuadraticModels = "f468eda6-eac5-11e8-05a5-ff9e497bcd19" begin
@require RipQP = "1e40b3f8-35eb-4cd8-8edd-3e515bb9de08" begin
include("../ext/ManoptRipQPQuadraticModelsExt.jl")
end
end
end
return nothing
end
#
# General
export ℝ, ℂ, &, |
export mid_point, mid_point!, reflect, reflect!
#
# Problems
export AbstractManoptProblem, DefaultManoptProblem, TwoManifoldProblem
#
# Objectives
export AbstractDecoratedManifoldObjective,
AbstractManifoldGradientObjective,
AbstractManifoldCostObjective,
AbstractManifoldObjective,
AbstractPrimalDualManifoldObjective,
ConstrainedManifoldObjective,
EmbeddedManifoldObjective,
ManifoldCountObjective,
NonlinearLeastSquaresObjective,
ManifoldAlternatingGradientObjective,
ManifoldCostGradientObjective,
ManifoldCostObjective,
ManifoldDifferenceOfConvexObjective,
ManifoldDifferenceOfConvexProximalObjective,
ManifoldGradientObjective,
ManifoldHessianObjective,
ManifoldProximalMapObjective,
ManifoldStochasticGradientObjective,
ManifoldSubgradientObjective,
PrimalDualManifoldObjective,
PrimalDualManifoldSemismoothNewtonObjective,
SimpleManifoldCachedObjective,
ManifoldCachedObjective
#
# Evaluation & Problems - old
export AbstractEvaluationType, AllocatingEvaluation, InplaceEvaluation, evaluation_type
#
# AbstractManoptSolverState
export AbstractGradientSolverState,
AbstractHessianSolverState,
AbstractManoptSolverState,
AbstractPrimalDualSolverState,
AdaptiveRegularizationState,
AlternatingGradientDescentState,
AugmentedLagrangianMethodState,
ConvexBundleMethodState,
ChambollePockState,
ConjugateGradientDescentState,
CyclicProximalPointState,
DifferenceOfConvexState,
DifferenceOfConvexProximalState,
DouglasRachfordState,
ExactPenaltyMethodState,
FrankWolfeState,
GradientDescentState,
LanczosState,
LevenbergMarquardtState,
NelderMeadState,
ParticleSwarmState,
PrimalDualSemismoothNewtonState,
ProximalBundleMethodState,
RecordSolverState,
StochasticGradientDescentState,
SubGradientMethodState,
TruncatedConjugateGradientState,
TrustRegionsState
# Objectives and Costs
export NelderMeadSimplex
export AlternatingGradient
#
# access functions and helpers for `AbstractManoptSolverState`
export default_stepsize
export get_cost, get_gradient, get_gradient!
export get_subgradient, get_subgradient!
export get_subtrahend_gradient!, get_subtrahend_gradient
export get_proximal_map, get_proximal_map!
export get_state,
get_initial_stepsize,
get_iterate,
get_gradients,
get_gradients!,
get_manifold,
get_preconditioner,
get_preconditioner!,
get_primal_prox,
get_primal_prox!,
get_differential_primal_prox,
get_differential_primal_prox!,
get_dual_prox,
get_dual_prox!,
get_differential_dual_prox,
get_differential_dual_prox!,
set_gradient!,
set_iterate!,
set_manopt_parameter!,
linearized_forward_operator,
linearized_forward_operator!,
adjoint_linearized_operator,
adjoint_linearized_operator!,
forward_operator,
forward_operator!,
get_objective
export get_hessian, get_hessian!
export ApproxHessianFiniteDifference
export is_state_decorator, dispatch_state_decorator
export primal_residual, dual_residual
export get_constraints,
get_inequality_constraint,
get_inequality_constraints,
get_equality_constraint,
get_equality_constraints,
get_grad_inequality_constraint,
get_grad_inequality_constraint!,
get_grad_inequality_constraints,
get_grad_inequality_constraints!,
get_grad_equality_constraint,
get_grad_equality_constraint!,
get_grad_equality_constraints,
get_grad_equality_constraints!
export ConstraintType, FunctionConstraint, VectorConstraint
# Subproblem cost/grad
export AugmentedLagrangianCost, AugmentedLagrangianGrad, ExactPenaltyCost, ExactPenaltyGrad
export ProximalDCCost, ProximalDCGrad, LinearizedDCCost, LinearizedDCGrad
export FrankWolfeCost, FrankWolfeGradient
export TrustRegionModelObjective
export QuasiNewtonState, QuasiNewtonLimitedMemoryDirectionUpdate
export QuasiNewtonMatrixDirectionUpdate
export QuasiNewtonCautiousDirectionUpdate,
BFGS, InverseBFGS, DFP, InverseDFP, SR1, InverseSR1
export InverseBroyden, Broyden
export AbstractQuasiNewtonDirectionUpdate, AbstractQuasiNewtonUpdateRule
export WolfePowellLinesearch, WolfePowellBinaryLinesearch
export AbstractStateAction, StoreStateAction
export has_storage, get_storage, update_storage!
export objective_cache_factory
#
# Direction Update Rules
export DirectionUpdateRule,
IdentityUpdateRule, StochasticGradient, AverageGradient, MomentumGradient, Nesterov
export DirectionUpdateRule,
SteepestDirectionUpdateRule,
HestenesStiefelCoefficient,
FletcherReevesCoefficient,
PolakRibiereCoefficient,
ConjugateDescentCoefficient,
LiuStoreyCoefficient,
DaiYuanCoefficient,
HagerZhangCoefficient,
ConjugateGradientBealeRestart
#
# Solvers
export adaptive_regularization_with_cubics,
adaptive_regularization_with_cubics!,
alternating_gradient_descent,
alternating_gradient_descent!,
augmented_Lagrangian_method,
augmented_Lagrangian_method!,
convex_bundle_method,
convex_bundle_method!,
ChambollePock,
ChambollePock!,
cma_es,
cma_es!,
conjugate_gradient_descent,
conjugate_gradient_descent!,
cyclic_proximal_point,
cyclic_proximal_point!,
difference_of_convex_algorithm,
difference_of_convex_algorithm!,
difference_of_convex_proximal_point,
difference_of_convex_proximal_point!,
DouglasRachford,
DouglasRachford!,
exact_penalty_method,
exact_penalty_method!,
Frank_Wolfe_method,
Frank_Wolfe_method!,
gradient_descent,
gradient_descent!,
LevenbergMarquardt,
LevenbergMarquardt!,
NelderMead,
NelderMead!,
particle_swarm,
particle_swarm!,
primal_dual_semismooth_Newton,
proximal_bundle_method,
proximal_bundle_method!,
quasi_Newton,
quasi_Newton!,
stochastic_gradient_descent,
stochastic_gradient_descent!,
subgradient_method,
subgradient_method!,
truncated_conjugate_gradient_descent,
truncated_conjugate_gradient_descent!,
trust_regions,
trust_regions!
# Solver helpers
export decorate_state!, decorate_objective!
export initialize_solver!, step_solver!, get_solver_result, stop_solver!
export solve!
export ApproxHessianFiniteDifference, ApproxHessianSymmetricRankOne, ApproxHessianBFGS
export update_hessian!, update_hessian_basis!
export ExactPenaltyCost, ExactPenaltyGrad, AugmentedLagrangianCost, AugmentedLagrangianGrad
export AdaptiveRagularizationWithCubicsModelObjective
export ExactPenaltyCost, ExactPenaltyGrad
export SmoothingTechnique, LinearQuadraticHuber, LogarithmicSumOfExponentials
#
# Stepsize
export Stepsize
export ArmijoLinesearch,
ConstantStepsize, DecreasingStepsize, Linesearch, NonmonotoneLinesearch
export AdaptiveWNGradient
export get_stepsize, get_initial_stepsize, get_last_stepsize
#
# Stopping Criteria
export StoppingCriterion, StoppingCriterionSet
export StopAfter,
StopAfterIteration,
StopWhenResidualIsReducedByFactorOrPower,
StopWhenAll,
StopWhenAllLanczosVectorsUsed,
StopWhenAny,
StopWhenBestCostInGenerationConstant,
StopWhenChangeLess,
StopWhenCostLess,
StopWhenCostNaN,
StopWhenCovarianceIllConditioned,
StopWhenCurvatureIsNegative,
StopWhenEntryChangeLess,
StopWhenEvolutionStagnates,
StopWhenGradientChangeLess,
StopWhenGradientNormLess,
StopWhenFirstOrderProgress,
StopWhenIterateNaN,
StopWhenLagrangeMultiplierLess,
StopWhenModelIncreased,
StopWhenPopulationCostConcentrated,
StopWhenPopulationConcentrated,
StopWhenPopulationDiverges,
StopWhenPopulationStronglyConcentrated,
StopWhenSmallerOrEqual,
StopWhenStepsizeLess,
StopWhenSubgradientNormLess,
StopWhenSwarmVelocityLess,
StopWhenTrustRegionIsExceeded
export get_active_stopping_criteria,
get_stopping_criteria, get_reason, get_stopping_criterion
export update_stopping_criterion!
#
# Exports
export asymptote_export_S2_signals, asymptote_export_S2_data, asymptote_export_SPD
export render_asymptote
#
# Debugs
export DebugSolverState, DebugAction, DebugGroup, DebugEntry, DebugEntryChange, DebugEvery
export DebugChange,
DebugGradientChange, DebugIterate, DebugIteration, DebugDivider, DebugTime
export DebugCost, DebugStoppingCriterion
export DebugGradient, DebugGradientNorm, DebugStepsize
export DebugPrimalBaseChange, DebugPrimalBaseIterate, DebugPrimalChange, DebugPrimalIterate
export DebugDualBaseChange, DebugDualBaseIterate, DebugDualChange, DebugDualIterate
export DebugDualResidual, DebugPrimalDualResidual, DebugPrimalResidual
export DebugProximalParameter, DebugWarnIfCostIncreases
export DebugGradient, DebugGradientNorm, DebugStepsize
export DebugWhenActive, DebugWarnIfFieldNotFinite, DebugIfEntry
export DebugWarnIfCostNotFinite, DebugWarnIfFieldNotFinite
export DebugWarnIfLagrangeMultiplierIncreases
export DebugWarnIfGradientNormTooLarge, DebugMessages
#
# Records - and access functions
export get_record, get_record_state, get_record_action, has_record, getindex
export RecordAction
export RecordGroup, RecordEvery
export RecordChange, RecordCost, RecordIterate, RecordIteration
export RecordEntry, RecordEntryChange, RecordTime
export RecordGradient, RecordGradientNorm, RecordStepsize
export RecordSubsolver, RecordWhenActive, RecordStoppingReason
export RecordPrimalBaseChange,
RecordPrimalBaseIterate, RecordPrimalChange, RecordPrimalIterate
export RecordStoppingReason, RecordWhenActive, RecordSubsolver
export RecordDualBaseChange, RecordDualBaseIterate, RecordDualChange, RecordDualIterate
export RecordProximalParameter
#
# Count
export get_count, reset_counters!
#
# Helpers
export check_gradient, check_differential, check_Hessian
end