SciML · ChrisRackauckas · Aug 17, 2022 · Aug 17, 2022
diff --git a/.JuliaFormatter.toml b/.JuliaFormatter.toml
@@ -0,0 +1 @@
+style = "sciml"
diff --git a/.github/workflows/FormatCheck.yml b/.github/workflows/FormatCheck.yml
@@ -0,0 +1,42 @@
+name: format-check
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'release-'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: [1]
+        julia-arch: [x86]
+        os: [ubuntu-latest]
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+
+      - uses: actions/checkout@v1
+      - name: Install JuliaFormatter and format
+        # This will use the latest version by default but you can set the version like so:
+        #
+        # julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
+        run: |
+          julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
+          julia  -e 'using JuliaFormatter; format(".", verbose=true)'
+      - name: Format check
+        run: |
+          julia -e '
+          out = Cmd(`git diff --name-only`) |> read |> String
+          if out == ""
+              exit(0)
+          else
+              @error "Some files have not been formatted !!!"
+              write(stdout, out)
+              exit(1)
+          end'
diff --git a/docs/make.jl b/docs/make.jl
@@ -3,22 +3,16 @@ using FiniteDiff, ForwardDiff, ModelingToolkit, ReverseDiff, Tracker, Zygote
 
 include("pages.jl")
 
-makedocs(
-    sitename="Optimization.jl",
-    authors="Chris Rackauckas, Vaibhav Kumar Dixit et al.",
-    clean=true,
-    doctest=false,
-    modules=[Optimization, Optimization.SciMLBase, FiniteDiff, 
+makedocs(sitename = "Optimization.jl",
+         authors = "Chris Rackauckas, Vaibhav Kumar Dixit et al.",
+         clean = true,
+         doctest = false,
+         modules = [Optimization, Optimization.SciMLBase, FiniteDiff,
              ForwardDiff, ModelingToolkit, ReverseDiff, Tracker, Zygote],
+         format = Documenter.HTML(analytics = "UA-90474609-3",
+                                  assets = ["assets/favicon.ico"],
+                                  canonical = "https://Optimization.sciml.ai/stable/"),
+         pages = pages)
 
-    format=Documenter.HTML(analytics = "UA-90474609-3",
-                           assets=["assets/favicon.ico"],
-                           canonical="https://Optimization.sciml.ai/stable/"),
-
-    pages=pages
-)
-
-deploydocs(
-    repo="github.com/SciML/Optimization.jl";
-    push_preview=true
-)
+deploydocs(repo = "github.com/SciML/Optimization.jl";
+           push_preview = true)
diff --git a/docs/pages.jl b/docs/pages.jl
@@ -1,34 +1,32 @@
 pages = [
-        "Optimization.jl: A Unified Optimization Package" => "index.md",
-
-        "Tutorials" => [
-            "tutorials/intro.md",
-            "tutorials/rosenbrock.md",
-            "tutorials/minibatch.md",
-            "tutorials/symbolic.md",
-            "tutorials/constraints.md",
-        ],
-
-        "API" => [
-            "API/optimization_problem.md",
-            "API/optimization_function.md",
-            "API/solve.md",
-            "API/modelingtoolkit.md"
-        ],
-        "Optimizer Packages" => [
-            "BlackBoxOptim.jl" => "optimization_packages/blackboxoptim.md",
-            "CMAEvolutionStrategy.jl" => "optimization_packages/cmaevolutionstrategy.md",
-            "Evolutionary.jl" => "optimization_packages/evolutionary.md",
-            "Flux.jl" => "optimization_packages/flux.md",
-            "GCMAES.jl" => "optimization_packages/gcmaes.md",
-            "MathOptInterface.jl" => "optimization_packages/mathoptinterface.md",
-            "MultistartOptimization.jl" => "optimization_packages/multistartoptimization.md",
-            "Metaheuristics.jl" => "optimization_packages/metaheuristics.md",
-            "NOMAD.jl" => "optimization_packages/nomad.md",
-            "NLopt.jl" => "optimization_packages/nlopt.md",
-            "Nonconvex.jl" => "optimization_packages/nonconvex.md",
-            "Optim.jl" => "optimization_packages/optim.md",
-            "Optimisers.jl" => "optimization_packages/optimisers.md",
-            "QuadDIRECT.jl" => "optimization_packages/quaddirect.md"
-        ],
-    ]
+    "Optimization.jl: A Unified Optimization Package" => "index.md",
+    "Tutorials" => [
+        "tutorials/intro.md",
+        "tutorials/rosenbrock.md",
+        "tutorials/minibatch.md",
+        "tutorials/symbolic.md",
+        "tutorials/constraints.md",
+    ],
+    "API" => [
+        "API/optimization_problem.md",
+        "API/optimization_function.md",
+        "API/solve.md",
+        "API/modelingtoolkit.md",
+    ],
+    "Optimizer Packages" => [
+        "BlackBoxOptim.jl" => "optimization_packages/blackboxoptim.md",
+        "CMAEvolutionStrategy.jl" => "optimization_packages/cmaevolutionstrategy.md",
+        "Evolutionary.jl" => "optimization_packages/evolutionary.md",
+        "Flux.jl" => "optimization_packages/flux.md",
+        "GCMAES.jl" => "optimization_packages/gcmaes.md",
+        "MathOptInterface.jl" => "optimization_packages/mathoptinterface.md",
+        "MultistartOptimization.jl" => "optimization_packages/multistartoptimization.md",
+        "Metaheuristics.jl" => "optimization_packages/metaheuristics.md",
+        "NOMAD.jl" => "optimization_packages/nomad.md",
+        "NLopt.jl" => "optimization_packages/nlopt.md",
+        "Nonconvex.jl" => "optimization_packages/nonconvex.md",
+        "Optim.jl" => "optimization_packages/optim.md",
+        "Optimisers.jl" => "optimization_packages/optimisers.md",
+        "QuadDIRECT.jl" => "optimization_packages/quaddirect.md",
+    ],
+]
diff --git a/lib/OptimizationBBO/src/OptimizationBBO.jl b/lib/OptimizationBBO/src/OptimizationBBO.jl
@@ -4,57 +4,57 @@ using BlackBoxOptim, Optimization, Optimization.SciMLBase
 
 abstract type BBO end
 
-for j = string.(BlackBoxOptim.SingleObjectiveMethodNames)
+for j in string.(BlackBoxOptim.SingleObjectiveMethodNames)
     eval(Meta.parse("Base.@kwdef struct BBO_" * j * " <: BBO method=:" * j * " end"))
     eval(Meta.parse("export BBO_" * j))
 end
 
 decompose_trace(opt::BlackBoxOptim.OptRunController) = BlackBoxOptim.best_candidate(opt)
 
 function __map_optimizer_args(prob::SciMLBase.OptimizationProblem, opt::BBO;
-    callback=nothing,
-    maxiters::Union{Number,Nothing}=nothing,
-    maxtime::Union{Number,Nothing}=nothing,
-    abstol::Union{Number,Nothing}=nothing,
-    reltol::Union{Number,Nothing}=nothing,
-    kwargs...)
-
+                              callback = nothing,
+                              maxiters::Union{Number, Nothing} = nothing,
+                              maxtime::Union{Number, Nothing} = nothing,
+                              abstol::Union{Number, Nothing} = nothing,
+                              reltol::Union{Number, Nothing} = nothing,
+                              kwargs...)
     if !isnothing(reltol)
         @warn "common reltol is currently not used by $(opt)"
     end
 
-    mapped_args = (; Method=opt.method,
-        SearchRange=[(prob.lb[i], prob.ub[i]) for i in 1:length(prob.lb)])
+    mapped_args = (; Method = opt.method,
+                   SearchRange = [(prob.lb[i], prob.ub[i]) for i in 1:length(prob.lb)])
 
     if !isnothing(callback)
-        mapped_args = (; mapped_args..., CallbackFunction=callback, CallbackInterval=0.0)
+        mapped_args = (; mapped_args..., CallbackFunction = callback,
+                       CallbackInterval = 0.0)
     end
 
     mapped_args = (; mapped_args..., kwargs...)
 
     if !isnothing(maxiters)
-        mapped_args = (; mapped_args..., MaxSteps=maxiters)
+        mapped_args = (; mapped_args..., MaxSteps = maxiters)
     end
 
     if !isnothing(maxtime)
-        mapped_args = (; mapped_args..., MaxTime=maxtime)
+        mapped_args = (; mapped_args..., MaxTime = maxtime)
     end
 
     if !isnothing(abstol)
-        mapped_args = (; mapped_args..., MinDeltaFitnessTolerance=abstol)
+        mapped_args = (; mapped_args..., MinDeltaFitnessTolerance = abstol)
     end
 
     return mapped_args
 end
 
-function SciMLBase.__solve(prob::SciMLBase.OptimizationProblem, opt::BBO, data=Optimization.DEFAULT_DATA;
-    callback=(args...) -> (false),
-    maxiters::Union{Number,Nothing}=nothing,
-    maxtime::Union{Number,Nothing}=nothing,
-    abstol::Union{Number,Nothing}=nothing,
-    reltol::Union{Number,Nothing}=nothing,
-    progress=false, kwargs...)
-
+function SciMLBase.__solve(prob::SciMLBase.OptimizationProblem, opt::BBO,
+                           data = Optimization.DEFAULT_DATA;
+                           callback = (args...) -> (false),
+                           maxiters::Union{Number, Nothing} = nothing,
+                           maxtime::Union{Number, Nothing} = nothing,
+                           abstol::Union{Number, Nothing} = nothing,
+                           reltol::Union{Number, Nothing} = nothing,
+                           progress = false, kwargs...)
     local x, cur, state
 
     if data != Optimization.DEFAULT_DATA
@@ -78,13 +78,14 @@ function SciMLBase.__solve(prob::SciMLBase.OptimizationProblem, opt::BBO, data=O
     maxiters = Optimization._check_and_convert_maxiters(maxiters)
     maxtime = Optimization._check_and_convert_maxtime(maxtime)
 
-
     _loss = function (θ)
         x = prob.f(θ, prob.p, cur...)
         return first(x)
     end
 
-    opt_args = __map_optimizer_args(prob, opt, callback=_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...)
 
@@ -95,7 +96,8 @@ function SciMLBase.__solve(prob::SciMLBase.OptimizationProblem, opt::BBO, data=O
     opt_ret = Symbol(opt_res.stop_reason)
 
     SciMLBase.build_solution(prob, opt, BlackBoxOptim.best_candidate(opt_res),
-        BlackBoxOptim.best_fitness(opt_res); original=opt_res, retcode=opt_ret)
+                             BlackBoxOptim.best_fitness(opt_res); original = opt_res,
+                             retcode = opt_ret)
 end
 
 end
diff --git a/lib/OptimizationBBO/test/runtests.jl b/lib/OptimizationBBO/test/runtests.jl
@@ -8,7 +8,8 @@ using Test
     l1 = rosenbrock(x0, _p)
 
     optprob = OptimizationFunction(rosenbrock)
-    prob = Optimization.OptimizationProblem(optprob, x0, _p, lb=[-1.0, -1.0], ub=[0.8, 0.8])
+    prob = Optimization.OptimizationProblem(optprob, x0, _p, lb = [-1.0, -1.0],
+                                            ub = [0.8, 0.8])
     sol = solve(prob, BBO_adaptive_de_rand_1_bin_radiuslimited())
     @test 10 * sol.minimum < l1
 end
diff --git a/lib/OptimizationCMAEvolutionStrategy/src/OptimizationCMAEvolutionStrategy.jl b/lib/OptimizationCMAEvolutionStrategy/src/OptimizationCMAEvolutionStrategy.jl
@@ -7,44 +7,43 @@ export CMAEvolutionStrategyOpt
 struct CMAEvolutionStrategyOpt end
 
 function __map_optimizer_args(prob::OptimizationProblem, opt::CMAEvolutionStrategyOpt;
-    callback=nothing,
-    maxiters::Union{Number,Nothing}=nothing,
-    maxtime::Union{Number,Nothing}=nothing,
-    abstol::Union{Number,Nothing}=nothing,
-    reltol::Union{Number,Nothing}=nothing,
-    kwargs...)
-
+                              callback = nothing,
+                              maxiters::Union{Number, Nothing} = nothing,
+                              maxtime::Union{Number, Nothing} = nothing,
+                              abstol::Union{Number, Nothing} = nothing,
+                              reltol::Union{Number, Nothing} = nothing,
+                              kwargs...)
     if !isnothing(reltol)
         @warn "common reltol is currently not used by $(opt)"
     end
 
-    mapped_args = (; lower=prob.lb,
-        upper=prob.ub,
-        kwargs...)
+    mapped_args = (; lower = prob.lb,
+                   upper = prob.ub,
+                   kwargs...)
 
     if !isnothing(maxiters)
-        mapped_args = (; mapped_args..., maxiter=maxiters)
+        mapped_args = (; mapped_args..., maxiter = maxiters)
     end
 
     if !isnothing(maxtime)
-        mapped_args = (; mapped_args..., maxtime=maxtime)
+        mapped_args = (; mapped_args..., maxtime = maxtime)
     end
 
     if !isnothing(abstol)
-        mapped_args = (; mapped_args..., ftol=abstol)
+        mapped_args = (; mapped_args..., ftol = abstol)
     end
 
     return mapped_args
 end
 
-
-function SciMLBase.__solve(prob::OptimizationProblem, opt::CMAEvolutionStrategyOpt, data=Optimization.DEFAULT_DATA;
-    callback=(args...) -> (false),
-    maxiters::Union{Number,Nothing}=nothing,
-    maxtime::Union{Number,Nothing}=nothing,
-    abstol::Union{Number,Nothing}=nothing,
-    reltol::Union{Number,Nothing}=nothing,
-    kwargs...)
+function SciMLBase.__solve(prob::OptimizationProblem, opt::CMAEvolutionStrategyOpt,
+                           data = Optimization.DEFAULT_DATA;
+                           callback = (args...) -> (false),
+                           maxiters::Union{Number, Nothing} = nothing,
+                           maxtime::Union{Number, Nothing} = nothing,
+                           abstol::Union{Number, Nothing} = nothing,
+                           reltol::Union{Number, Nothing} = nothing,
+                           kwargs...)
     local x, cur, state
 
     if data != Optimization.DEFAULT_DATA
@@ -70,15 +69,19 @@ function SciMLBase.__solve(prob::OptimizationProblem, opt::CMAEvolutionStrategyO
         return first(x)
     end
 
-    opt_args = __map_optimizer_args(prob, opt, callback=_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...)
     t1 = time()
 
     opt_ret = opt_res.stop.reason
 
-    SciMLBase.build_solution(prob, opt, opt_res.logger.xbest[end], opt_res.logger.fbest[end]; original=opt_res, retcode=opt_ret)
+    SciMLBase.build_solution(prob, opt, opt_res.logger.xbest[end],
+                             opt_res.logger.fbest[end]; original = opt_res,
+                             retcode = opt_ret)
 end
 
 end
diff --git a/lib/OptimizationCMAEvolutionStrategy/test/runtests.jl b/lib/OptimizationCMAEvolutionStrategy/test/runtests.jl
@@ -7,7 +7,7 @@ using Test
     _p = [1.0, 100.0]
     l1 = rosenbrock(x0, _p)
     f = OptimizationFunction(rosenbrock)
-    prob = OptimizationProblem(f, x0, _p, lb=[-1.0, -1.0], ub=[0.8, 0.8])
+    prob = OptimizationProblem(f, x0, _p, lb = [-1.0, -1.0], ub = [0.8, 0.8])
     sol = solve(prob, CMAEvolutionStrategyOpt())
     @test 10 * sol.minimum < l1
 end