fix: remove uses of LineSearches.jl backtracking

SciML · Oct 21, 2024 · 961c8e7 · 961c8e7
1 parent e7e218b
commit 961c8e7
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 38 deletions.
diff --git a/.github/workflows/Downgrade.yml b/.github/workflows/Downgrade.yml
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: ["1"]
+        version: ["1.10"]
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "NonlinearSolve"
 uuid = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
 authors = ["SciML"]
-version = "3.15.1"
+version = "3.15.2"
 
 [deps]
 ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
@@ -80,7 +80,7 @@ Hwloc = "3"
 InteractiveUtils = "<0.0.1, 1"
 LazyArrays = "1.8.2, 2"
 LeastSquaresOptim = "0.8.5"
-LineSearch = "0.1.2"
+LineSearch = "0.1.4"
 LineSearches = "7.3"
 LinearAlgebra = "1.10"
 LinearSolve = "2.35"
@@ -96,7 +96,7 @@ Pkg = "1.10"
 PrecompileTools = "1.2"
 Preferences = "1.4"
 Printf = "1.10"
-Random = "1.91"
+Random = "1.10"
 ReTestItems = "1.24"
 RecursiveArrayTools = "3.27"
 Reexport = "1.2"

diff --git a/src/NonlinearSolve.jl b/src/NonlinearSolve.jl
@@ -176,7 +176,7 @@ export NewtonDescent, SteepestDescent, Dogleg, DampedNewtonDescent, GeodesicAcce
 ## Line Search Algorithms
 export LineSearchesJL, LiFukushimaLineSearch # FIXME: deprecated. use LineSearch.jl directly
 export Static, HagerZhang, MoreThuente, StrongWolfe, BackTracking  # FIXME: deprecated
-export NoLineSearch, RobustNonMonotoneLineSearch
+export LineSearch, NoLineSearch, RobustNonMonotoneLineSearch
 ## Trust Region Algorithms
 export RadiusUpdateSchemes
 

diff --git a/src/default.jl b/src/default.jl
@@ -364,9 +364,7 @@ function RobustMultiNewton(::Type{T} = Float64; concrete_jac = nothing, linsolve
                 radius_update_scheme = RadiusUpdateSchemes.Bastin),
             NewtonRaphson(; concrete_jac, linsolve, precs, autodiff),
             NewtonRaphson(; concrete_jac, linsolve, precs,
-                linesearch = LineSearch.LineSearchesJL(;
-                    method = LineSearches.BackTracking()),
-                autodiff),
+                linesearch = LineSearch.BackTracking(), autodiff),
             TrustRegion(; concrete_jac, linsolve, precs,
                 radius_update_scheme = RadiusUpdateSchemes.NLsolve, autodiff),
             TrustRegion(; concrete_jac, linsolve, precs,
@@ -407,9 +405,7 @@ function FastShortcutNonlinearPolyalg(
         else
             algs = (NewtonRaphson(; concrete_jac, linsolve, precs, autodiff),
                 NewtonRaphson(; concrete_jac, linsolve, precs,
-                    linesearch = LineSearch.LineSearchesJL(;
-                        method = LineSearches.BackTracking()),
-                    autodiff),
+                    linesearch = LineSearch.BackTracking(), autodiff),
                 TrustRegion(; concrete_jac, linsolve, precs, autodiff),
                 TrustRegion(; concrete_jac, linsolve, precs,
                     radius_update_scheme = RadiusUpdateSchemes.Bastin, autodiff))
@@ -430,9 +426,7 @@ function FastShortcutNonlinearPolyalg(
                     SimpleKlement(),
                     NewtonRaphson(; concrete_jac, linsolve, precs, autodiff),
                     NewtonRaphson(; concrete_jac, linsolve, precs,
-                        linesearch = LineSearch.LineSearchesJL(;
-                            method = LineSearches.BackTracking()),
-                        autodiff),
+                        linesearch = LineSearch.BackTracking(), autodiff),
                     TrustRegion(; concrete_jac, linsolve, precs,
                         radius_update_scheme = RadiusUpdateSchemes.Bastin, autodiff))
             end
@@ -451,9 +445,7 @@ function FastShortcutNonlinearPolyalg(
                     Klement(; linsolve, precs, autodiff),
                     NewtonRaphson(; concrete_jac, linsolve, precs, autodiff),
                     NewtonRaphson(; concrete_jac, linsolve, precs,
-                        linesearch = LineSearch.LineSearchesJL(;
-                            method = LineSearches.BackTracking()),
-                        autodiff),
+                        linesearch = LineSearch.BackTracking(), autodiff),
                     TrustRegion(; concrete_jac, linsolve, precs, autodiff),
                     TrustRegion(; concrete_jac, linsolve, precs,
                         radius_update_scheme = RadiusUpdateSchemes.Bastin, autodiff))
@@ -489,9 +481,7 @@ function FastShortcutNLLSPolyalg(
                 linsolve, precs, disable_geodesic = Val(true), autodiff, kwargs...),
             TrustRegion(; concrete_jac, linsolve, precs, autodiff, kwargs...),
             GaussNewton(; concrete_jac, linsolve, precs,
-                linesearch = LineSearch.LineSearchesJL(;
-                    method = LineSearches.BackTracking()),
-                autodiff, kwargs...),
+                linesearch = LineSearch.BackTracking(), autodiff, kwargs...),
             TrustRegion(; concrete_jac, linsolve, precs,
                 radius_update_scheme = RadiusUpdateSchemes.Bastin, autodiff, kwargs...),
             LevenbergMarquardt(; linsolve, precs, autodiff, kwargs...))

diff --git a/test/core/rootfind_tests.jl b/test/core/rootfind_tests.jl
@@ -53,11 +53,15 @@ end
 # --- NewtonRaphson tests ---
 
 @testitem "NewtonRaphson" setup=[CoreRootfindTesting] tags=[:core] begin
-    @testset "LineSearch: $(_nameof(lsmethod)) LineSearch AD: $(_nameof(ad))" for lsmethod in (
-            Static(), StrongWolfe(), BackTracking(), HagerZhang(), MoreThuente()),
-        ad in (AutoForwardDiff(), AutoZygote(), AutoFiniteDiff())
+    @testset "LineSearch: $(_nameof(linesearch)) LineSearch AD: $(_nameof(ad))" for ad in (
+            AutoForwardDiff(), AutoZygote(), AutoFiniteDiff()
+        ),
+        linesearch in (
+            Static(; autodiff = ad), StrongWolfe(; autodiff = ad),
+            BackTracking(; autodiff = ad), LineSearch.BackTracking(; autodiff = ad),
+            HagerZhang(; autodiff = ad), MoreThuente(; autodiff = ad)
+        )
 
-        linesearch = LineSearchesJL(; method = lsmethod, autodiff = ad)
         u0s = ([1.0, 1.0], @SVector[1.0, 1.0], 1.0)
 
         @testset "[OOP] u0: $(typeof(u0))" for u0 in u0s
@@ -463,14 +467,17 @@ end
 # --- Broyden tests ---
 
 @testitem "Broyden" setup=[CoreRootfindTesting] tags=[:core] begin
-    @testset "LineSearch: $(_nameof(lsmethod)) LineSearch AD: $(_nameof(ad)) Init Jacobian: $(init_jacobian) Update Rule: $(update_rule)" for lsmethod in (
-            Static(), StrongWolfe(), BackTracking(),
-            HagerZhang(), MoreThuente(), LiFukushimaLineSearch()),
-        ad in (AutoForwardDiff(), AutoZygote(), AutoFiniteDiff()),
+    @testset "LineSearch: $(_nameof(linesearch)) LineSearch AD: $(_nameof(ad)) Init Jacobian: $(init_jacobian) Update Rule: $(update_rule)" for ad in (
+            AutoForwardDiff(), AutoZygote(), AutoFiniteDiff()
+        ),
+        linesearch in (
+            Static(; autodiff = ad), StrongWolfe(; autodiff = ad),
+            BackTracking(; autodiff = ad), LineSearch.BackTracking(; autodiff = ad),
+            HagerZhang(; autodiff = ad), MoreThuente(; autodiff = ad)
+        ),
         init_jacobian in (Val(:identity), Val(:true_jacobian)),
         update_rule in (Val(:good_broyden), Val(:bad_broyden), Val(:diagonal))
 
-        linesearch = LineSearchesJL(; method = lsmethod, autodiff = ad)
         u0s = ([1.0, 1.0], @SVector[1.0, 1.0], 1.0)
 
         @testset "[OOP] u0: $(typeof(u0))" for u0 in u0s
@@ -513,12 +520,16 @@ end
 # --- Klement tests ---
 
 @testitem "Klement" setup=[CoreRootfindTesting] tags=[:core] begin
-    @testset "LineSearch: $(_nameof(lsmethod)) LineSearch AD: $(_nameof(ad)) Init Jacobian: $(init_jacobian)" for lsmethod in (
-            Static(), StrongWolfe(), BackTracking(), HagerZhang(), MoreThuente()),
-        ad in (AutoForwardDiff(), AutoZygote(), AutoFiniteDiff()),
+    @testset "LineSearch: $(_nameof(linesearch)) LineSearch AD: $(_nameof(ad)) Init Jacobian: $(init_jacobian)" for ad in (
+            AutoForwardDiff(), AutoZygote(), AutoFiniteDiff()
+        ),
+        linesearch in (
+            Static(; autodiff = ad), StrongWolfe(; autodiff = ad),
+            BackTracking(; autodiff = ad), LineSearch.BackTracking(; autodiff = ad),
+            HagerZhang(; autodiff = ad), MoreThuente(; autodiff = ad)
+        ),
         init_jacobian in (Val(:identity), Val(:true_jacobian), Val(:true_jacobian_diagonal))
 
-        linesearch = LineSearchesJL(; method = lsmethod, autodiff = ad)
         u0s = ([1.0, 1.0], @SVector[1.0, 1.0], 1.0)
 
         @testset "[OOP] u0: $(typeof(u0))" for u0 in u0s
@@ -562,12 +573,16 @@ end
 # --- LimitedMemoryBroyden tests ---
 
 @testitem "LimitedMemoryBroyden" setup=[CoreRootfindTesting] tags=[:core] begin
-    @testset "LineSearch: $(_nameof(lsmethod)) LineSearch AD: $(_nameof(ad))" for lsmethod in (
-            Static(), StrongWolfe(), BackTracking(),
-            HagerZhang(), MoreThuente(), LiFukushimaLineSearch()),
-        ad in (AutoForwardDiff(), AutoZygote(), AutoFiniteDiff())
+    @testset "LineSearch: $(_nameof(linesearch)) LineSearch AD: $(_nameof(ad))" for ad in (
+            AutoForwardDiff(), AutoZygote(), AutoFiniteDiff()
+        ),
+        linesearch in (
+            Static(; autodiff = ad), StrongWolfe(; autodiff = ad),
+            BackTracking(; autodiff = ad), LineSearch.BackTracking(; autodiff = ad),
+            HagerZhang(; autodiff = ad), MoreThuente(; autodiff = ad),
+            LiFukushimaLineSearch()
+        )
 
-        linesearch = LineSearchesJL(; method = lsmethod, autodiff = ad)
         u0s = ([1.0, 1.0], @SVector[1.0, 1.0], 1.0)
 
         @testset "[OOP] u0: $(typeof(u0))" for u0 in u0s