change cb to callback

This makes GalacticOptim match the common interface arguments.

I'm counting this as part of GalacticOptim v3 since the component solvers haven't been released so it hasn't been possible to use it anyways.

Author: ChrisRackauckas

docs/src/API/solve.md

@@ -13,7 +13,7 @@ These common arguments are:
 - `maxtime` (the maximum of time the optimization runs for)
 - `abstol` (absolute tolerance in changes of the objective value)
 - `reltol` (relative tolerance  in changes of the objective value)
-- `cb` (a callback function)
+- `callback` (a callback function)
 
 If the chosen global optimzer employs a local optimization method a similiar set of common local optimizer arguments exists.
 The common local optimizer arguments are:
@@ -38,16 +38,16 @@ If a common argument is not implemented for a optimizer a warning will be shown.
 
 ## Callback Functions
 
-The callback function `cb` is a function which is called after every optimizer
+The callback function `callback` is a function which is called after every optimizer
 step. Its signature is:
 
 ```julia
-cb = (x,other_args) -> false
+callback = (x,other_args) -> false
 ```
 
 where `other_args` is are the extra return arguments of the optimization `f`.
-For example, if `f(x,p) = 5x`, then `cb = (x) -> ...` is used. If `f(x,p) = 5x,55x`,
-then `cb = (x,extra) -> ...` is used, where `extra = 55x`. This allows for saving
+For example, if `f(x,p) = 5x`, then `callback = (x) -> ...` is used. If `f(x,p) = 5x,55x`,
+then ` = (x,extra) -> ...` is used, where `extra = 55x`. This allows for saving
 values from the optimization and using them for plotting and display without
 recalculating. The callback should return a Boolean value, and the default 
 should be `false`, such that the optimization gets stopped if it returns `true`.

docs/src/tutorials/minibatch.md

@@ -23,7 +23,7 @@ function dudt_(u,p,t)
     ann(u, p).* u
 end
 
-cb = function (p,l,pred;doplot=false) #callback function to observe training
+callback = function (p,l,pred;doplot=false) #callback function to observe training
     display(l)
     # plot current prediction against data
     if doplot
@@ -65,6 +65,6 @@ l1 = loss_adjoint(pp, train_loader.data[1], train_loader.data[2])[1]
 optfun = OptimizationFunction((θ, p, batch, time_batch) -> loss_adjoint(θ, batch, time_batch), GalacticOptim.AutoZygote())
 optprob = OptimizationProblem(optfun, pp)
 using IterTools: ncycle
-res1 = GalacticOptim.solve(optprob, ADAM(0.05), ncycle(train_loader, numEpochs), cb = cb)
+res1 = GalacticOptim.solve(optprob, ADAM(0.05), ncycle(train_loader, numEpochs), callback = callback)
 @test 10res1.minimum < l1
 ```

lib/GalacticBBO/src/GalacticBBO.jl

@@ -12,7 +12,7 @@ end
 decompose_trace(opt::BlackBoxOptim.OptRunController) = BlackBoxOptim.best_candidate(opt)
 
 function __map_optimizer_args(prob::SciMLBase.OptimizationProblem, opt::BBO;
-    cb=nothing,
+    callback=nothing,
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,
@@ -26,8 +26,8 @@ function __map_optimizer_args(prob::SciMLBase.OptimizationProblem, opt::BBO;
     mapped_args = (; Method=opt.method,
         SearchRange=[(prob.lb[i], prob.ub[i]) for i in 1:length(prob.lb)])
 
-    if !isnothing(cb)
-        mapped_args = (; mapped_args..., CallbackFunction=cb, CallbackInterval=0.0)
+    if !isnothing(callback)
+        mapped_args = (; mapped_args..., CallbackFunction=callback, CallbackInterval=0.0)
     end
 
     mapped_args = (; mapped_args..., kwargs...)
@@ -48,7 +48,7 @@ function __map_optimizer_args(prob::SciMLBase.OptimizationProblem, opt::BBO;
 end
 
 function SciMLBase.__solve(prob::SciMLBase.OptimizationProblem, opt::BBO, data=GalacticOptim.DEFAULT_DATA;
-    cb=(args...) -> (false),
+    callback=(args...) -> (false),
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,
@@ -64,7 +64,7 @@ function SciMLBase.__solve(prob::SciMLBase.OptimizationProblem, opt::BBO, data=G
     cur, state = iterate(data)
 
     function _cb(trace)
-        cb_call = cb(decompose_trace(trace), x...)
+        cb_call = callback(decompose_trace(trace), x...)
         if !(typeof(cb_call) <: Bool)
             error("The callback should return a boolean `halt` for whether to stop the optimization process.")
         end
@@ -84,7 +84,7 @@ function SciMLBase.__solve(prob::SciMLBase.OptimizationProblem, opt::BBO, data=G
         return first(x)
     end
 
-    opt_args = __map_optimizer_args(prob, opt, cb=_cb, maxiters=maxiters, maxtime=maxtime, abstol=abstol, reltol=reltol; kwargs...)
+    opt_args = __map_optimizer_args(prob, opt, callback=_cb, maxiters=maxiters, maxtime=maxtime, abstol=abstol, reltol=reltol; kwargs...)
 
     opt_setup = BlackBoxOptim.bbsetup(_loss; opt_args...)
 

lib/GalacticCMAEvolutionStrategy/src/GalacticCMAEvolutionStrategy.jl

@@ -7,7 +7,7 @@ export CMAEvolutionStrategyOpt
 struct CMAEvolutionStrategyOpt end
 
 function __map_optimizer_args(prob::OptimizationProblem, opt::CMAEvolutionStrategyOpt;
-    cb=nothing,
+    callback=nothing,
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,
@@ -39,7 +39,7 @@ end
 
 
 function SciMLBase.__solve(prob::OptimizationProblem, opt::CMAEvolutionStrategyOpt, data=GalacticOptim.DEFAULT_DATA;
-    cb=(args...) -> (false),
+    callback=(args...) -> (false),
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,
@@ -54,7 +54,7 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::CMAEvolutionStrategyO
     cur, state = iterate(data)
 
     function _cb(trace)
-        cb_call = cb(decompose_trace(trace).metadata["x"], trace.value...)
+        cb_call = callback(decompose_trace(trace).metadata["x"], trace.value...)
         if !(typeof(cb_call) <: Bool)
             error("The callback should return a boolean `halt` for whether to stop the optimization process.")
         end
@@ -70,7 +70,7 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::CMAEvolutionStrategyO
         return first(x)
     end
 
-    opt_args = __map_optimizer_args(prob, opt, cb=_cb, maxiters=maxiters, maxtime=maxtime, abstol=abstol, reltol=reltol; kwargs...)
+    opt_args = __map_optimizer_args(prob, opt, callback=_cb, maxiters=maxiters, maxtime=maxtime, abstol=abstol, reltol=reltol; kwargs...)
 
     t0 = time()
     opt_res = CMAEvolutionStrategy.minimize(_loss, prob.u0, 0.1; opt_args...)

lib/GalacticEvolutionary/src/GalacticEvolutionary.jl

@@ -11,7 +11,7 @@ function Evolutionary.trace!(record::Dict{String,Any}, objfun, state, population
 end
 
 function __map_optimizer_args(prob::OptimizationProblem, opt::Evolutionary.AbstractOptimizer;
-    cb=nothing,
+    callback=nothing,
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,
@@ -22,8 +22,8 @@ function __map_optimizer_args(prob::OptimizationProblem, opt::Evolutionary.Abstr
 
     mapped_args = (; mapped_args..., kwargs...)
 
-    if !isnothing(cb)
-        mapped_args = (; mapped_args..., callback=cb)
+    if !isnothing(callback)
+        mapped_args = (; mapped_args..., callback=callback)
     end
 
     if !isnothing(maxiters)
@@ -46,7 +46,7 @@ function __map_optimizer_args(prob::OptimizationProblem, opt::Evolutionary.Abstr
 end
 
 function SciMLBase.__solve(prob::OptimizationProblem, opt::Evolutionary.AbstractOptimizer, data=GalacticOptim.DEFAULT_DATA;
-    cb=(args...) -> (false),
+    callback=(args...) -> (false),
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,
@@ -61,7 +61,7 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::Evolutionary.Abstract
     cur, state = iterate(data)
 
     function _cb(trace)
-        cb_call = cb(decompose_trace(trace).metadata["x"], trace.value...)
+        cb_call = callback(decompose_trace(trace).metadata["x"], trace.value...)
         if !(typeof(cb_call) <: Bool)
             error("The callback should return a boolean `halt` for whether to stop the optimization process.")
         end
@@ -77,7 +77,7 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::Evolutionary.Abstract
         return first(x)
     end
 
-    opt_args = __map_optimizer_args(prob, opt, cb=_cb, maxiters=maxiters, maxtime=maxtime, abstol=abstol, reltol=reltol; kwargs...)
+    opt_args = __map_optimizer_args(prob, opt, callback=_cb, maxiters=maxiters, maxtime=maxtime, abstol=abstol, reltol=reltol; kwargs...)
 
     t0 = time()
     if isnothing(prob.ub) | isnothing(prob.ub)

lib/GalacticFlux/src/GalacticFlux.jl

@@ -4,7 +4,7 @@ using GalacticOptim, Reexport, Printf, ProgressLogging, GalacticOptim.SciMLBase
 @reexport using Flux
 
 function SciMLBase.__solve(prob::OptimizationProblem, opt::Flux.Optimise.AbstractOptimiser, data = GalacticOptim.DEFAULT_DATA;
-    maxiters::Number = 0, cb = (args...) -> (false),
+    maxiters::Number = 0, callback = (args...) -> (false),
     progress = false, save_best = true, kwargs...)
 
     if data != GalacticOptim.DEFAULT_DATA
@@ -31,7 +31,7 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::Flux.Optimise.Abstrac
         for (i, d) in enumerate(data)
             f.grad(G, θ, d...)
             x = f.f(θ, prob.p, d...)
-            cb_call = cb(θ, x...)
+            cb_call = callback(θ, x...)
             if !(typeof(cb_call) <: Bool)
                 error("The callback should return a boolean `halt` for whether to stop the optimization process. Please see the sciml_train documentation for information.")
             elseif cb_call
@@ -50,7 +50,7 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::Flux.Optimise.Abstrac
                     opt = min_opt
                     x = min_err
                     θ = min_θ
-                    cb(θ, x...)
+                    callback(θ, x...)
                     break
                 end
             end

lib/GalacticGCMAES/src/GalacticGCMAES.jl

@@ -7,7 +7,7 @@ export GCMAESOpt
 struct GCMAESOpt end
 
 function __map_optimizer_args(prob::OptimizationProblem, opt::GCMAESOpt;
-    cb=nothing,
+    callback=nothing,
     maxiters::Union{Number, Nothing}=nothing,
     maxtime::Union{Number, Nothing}=nothing,
     abstol::Union{Number, Nothing}=nothing,

lib/GalacticMetaheuristics/src/GalacticMetaheuristics.jl

@@ -19,7 +19,7 @@ function initial_population!(opt, prob, bounds, f)
 end
 
 function __map_optimizer_args!(prob::OptimizationProblem, opt::Metaheuristics.AbstractAlgorithm;
-    cb=nothing,
+    callback=nothing,
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,
@@ -36,7 +36,7 @@ function __map_optimizer_args!(prob::OptimizationProblem, opt::Metaheuristics.Ab
         end
     end
 
-    if !isnothing(cb)
+    if !isnothing(callback)
         @warn "Callback argument is currently not used by $(typeof(opt).super)"
     end
 
@@ -59,7 +59,7 @@ function __map_optimizer_args!(prob::OptimizationProblem, opt::Metaheuristics.Ab
 end
 
 function SciMLBase.__solve(prob::OptimizationProblem, opt::Metaheuristics.AbstractAlgorithm;
-    cb=nothing,
+    callback=nothing,
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,
@@ -97,7 +97,7 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::Metaheuristics.Abstra
         @warn "Inequality constraints are current not passed on by GalacticOptim"
     end
 
-    __map_optimizer_args!(prob, opt, cb=cb, maxiters=maxiters, maxtime=maxtime, abstol=abstol, reltol=reltol; kwargs...)
+    __map_optimizer_args!(prob, opt, callback=callback, maxiters=maxiters, maxtime=maxtime, abstol=abstol, reltol=reltol; kwargs...)
 
     if use_initial
         initial_population!(opt, prob, opt_bounds, _loss)

lib/GalacticNLopt/src/GalacticNLopt.jl

@@ -6,7 +6,7 @@ using Reexport, GalacticOptim, GalacticOptim.SciMLBase
 (f::NLopt.Algorithm)() = f
 
 function __map_optimizer_args!(prob::OptimizationProblem, opt::NLopt.Opt;
-    cb=nothing,
+    callback=nothing,
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,
@@ -86,7 +86,7 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::Union{NLopt.Algorithm
     abstol::Union{Number,Nothing}=nothing,
     reltol::Union{Number,Nothing}=nothing,
     progress=false,
-    cb=(args...) -> (false),
+    callback=(args...) -> (false),
     kwargs...)
     local x
 
@@ -100,7 +100,7 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::Union{NLopt.Algorithm
 
     _loss = function (θ)
         x = f.f(θ, prob.p)
-        cb(θ, x...)
+        callback(θ, x...)
         return x[1]
     end
 

lib/GalacticNOMAD/src/GalacticNOMAD.jl

@@ -7,7 +7,7 @@ struct NOMADOpt end
 
 
 function __map_optimizer_args!(prob::OptimizationProblem, opt::NOMAD.NomadProblem;
-    cb=nothing,
+    callback=nothing,
     maxiters::Union{Number,Nothing}=nothing,
     maxtime::Union{Number,Nothing}=nothing,
     abstol::Union{Number,Nothing}=nothing,