Skip to content

Use DEFAULT_CALLBACK const in OptimJL/Optimisers __init #1407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ChrisRackauckas-Claude wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Use DEFAULT_CALLBACK const in OptimJL/Optimisers __init #1407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fca7c5
Use DEFAULT_CALLBACK const in OptimJL/Optimisers __init
ChrisRackauckas Oct 10, 2026
6a8e6e6
Qualify DEFAULT_CALLBACK for explicit-import sibling PRs
ChrisRackauckas Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/OptimizationOptimJL/src/OptimizationOptimJL.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ function SciMLBase.__init(
Optim.AbstractOptimizer, Optim.Fminbox,
Optim.SAMIN, Optim.ConstrainedOptimizer,
};
callback = (args...) -> (false),
callback = OptimizationBase.DEFAULT_CALLBACK,
maxiters::Union{Number, Nothing} = nothing,
maxtime::Union{Number, Nothing} = nothing,
abstol::Union{Number, Nothing} = nothing,
Expand Down
9 changes: 9 additions & 0 deletions lib/OptimizationOptimJL/test/core_tests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,4 +429,13 @@ end
sol_c = solve(prob_c, IPNewton())
@test sol_c.retcode isa SciMLBase.ReturnCode.T
end

# Default callback must be a stable const so init with/without kwargs share a cache type.
@testset "DEFAULT_CALLBACK type stability across kwargs" begin
rb(x, p) = (p[1] - x[1])^2 + p[2] * (x[2] - x[1]^2)^2
optf = OptimizationFunction(rb, OptimizationBase.AutoForwardDiff())
prob = OptimizationProblem(optf, zeros(2), [1.0, 100.0])
@test typeof(OptimizationBase.init(prob, LBFGS())) ==
typeof(OptimizationBase.init(prob, LBFGS(); maxiters = 100))
end
end
2 changes: 1 addition & 1 deletion lib/OptimizationOptimisers/src/OptimizationOptimisers.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ SciMLBase.allowscallback(opt::AbstractRule) = true

function SciMLBase.__init(
prob::SciMLBase.OptimizationProblem, opt::AbstractRule;
callback = (args...) -> (false),
callback = OptimizationBase.DEFAULT_CALLBACK,
epochs::Union{Number, Nothing} = nothing,
maxiters::Union{Number, Nothing} = nothing,
save_best::Bool = true, progress::Bool = false, kwargs...
Expand Down
9 changes: 9 additions & 0 deletions lib/OptimizationOptimisers/test/core_tests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,3 +328,12 @@ end
)
@test sol.u.data ≈ [-1.0e9, -1.0e9]
end

# Default callback must be a stable const so init with/without kwargs share a cache type.
@testset "DEFAULT_CALLBACK type stability across kwargs" begin
loss(x, p) = (p[1] - x[1])^2 + (p[2] - x[2])^2
optf = OptimizationFunction(loss, OptimizationBase.AutoForwardDiff())
prob = OptimizationProblem(optf, zeros(2), [1.0, 2.0])
@test typeof(OptimizationBase.init(prob, Optimisers.Adam())) ==
typeof(OptimizationBase.init(prob, Optimisers.Adam(); maxiters = 100))
end
Loading