better-optimize 0.1__tar.gz → 0.1.2__tar.gz

{better_optimize-0.1 → better_optimize-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better_optimize
-Version: 0.1
+Version: 0.1.2
 Summary: A drop-in replacement for scipy optimize functions with quality of life improvements
 License: MIT License
 Project-URL: Homepage, https://github.com/jessegrabowski/better_optimize

{better_optimize-0.1 → better_optimize-0.1.2}/better_optimize/__init__.py

@@ -1,6 +1,7 @@
 import logging
 
 from better_optimize._version import get_versions
+from better_optimize.basinhopping import basinhopping
 from better_optimize.minimize import minimize
 from better_optimize.root import root
 
@@ -14,4 +15,4 @@ if not logging.root.handlers:
 
 
 __version__ = get_versions()["version"]
-__all__ = ["minimize", "root"]
+__all__ = ["minimize", "root", "basinhopping"]

{better_optimize-0.1 → better_optimize-0.1.2}/better_optimize/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-04-07T14:48:10+0200",
+ "date": "2025-05-14T08:34:39+0200",
  "dirty": false,
  "error": null,
- "full-revisionid": "21632a7508f32aa1de12b701842d56e3eca319e2",
- "version": "0.1"
+ "full-revisionid": "b9f19e0aad67eca088085f337a4627b537f71e3c",
+ "version": "0.1.2"
 }
 '''  # END VERSION_JSON
 

{better_optimize-0.1 → better_optimize-0.1.2}/better_optimize/basinhopping.py

@@ -17,6 +17,7 @@ from scipy.optimize._basinhopping import (
     Metropolis,
     MinimizerWrapper,
     RandomDisplacement,
+    Storage,
     check_random_state,
 )
 
@@ -57,6 +58,35 @@ def initialize_progress_bar(progressbar, use_jac=True, use_hess=False):
     )
 
 
+class AllowFailureStorage(Storage):
+    """
+    Subclass of Storage that allows the minimizer to fail, but still updates the global minimum
+    if the new point is better than the current global minimum.
+    """
+
+    def update(self, minres):
+        if minres.fun < self.minres.fun:
+            self._add(minres)
+            return True
+        else:
+            return False
+
+
+class AllowFailureBasinHoppingRunner(BasinHoppingRunner):
+    """
+    A subclass of BasinHoppingRunner that allows the minimizer to fail, but still updates the
+    global minimum if the new point is better than the current global minimum.
+    """
+
+    def __init__(
+        self, x0, minimizer, step_taking, accept_tests, accept_on_minimizer_fail=False, disp=False
+    ):
+        super().__init__(x0, minimizer, step_taking, accept_tests, disp=disp)
+
+        if accept_on_minimizer_fail:
+            self.storage = AllowFailureStorage(self.storage.minres)
+
+
 def basinhopping(
     func: Callable[..., float | np.ndarray],
     x0: Sequence[float],
@@ -66,6 +96,7 @@ def basinhopping(
     minimizer_kwargs: dict | None = None,
     take_step: Callable | None = None,
     accept_test: Callable | None = None,
+    accept_on_minimizer_fail: bool = False,
     callback: Callable | None = None,
     interval: int = 50,
     progressbar: bool = True,
@@ -97,6 +128,9 @@ def basinhopping(
         Custom step-taking routine
     accept_test: Callable, optional
         Custom accept/reject routine
+    accept_on_minimizer_fail: bool
+        Accept the new point even if the minimizer fails. Will also update the global minimum if the point is
+        better than the current global minimum, even if the minimizer fails.
     callback: Callable, optional
         User-supplied function to call after each iteration
     interval: int
@@ -214,7 +248,14 @@ def basinhopping(
     if niter_success is None:
         niter_success = niter + 2
 
-    bh = BasinHoppingRunner(x0, wrapped_minimizer, take_step_wrapped, accept_tests, disp=verbose)
+    bh = AllowFailureBasinHoppingRunner(
+        x0,
+        wrapped_minimizer,
+        take_step_wrapped,
+        accept_tests,
+        accept_on_minimizer_fail=accept_on_minimizer_fail,
+        disp=verbose,
+    )
 
     # The wrapped minimizer is called once during construction of
     # BasinHoppingRunner, so run the callback
@@ -224,7 +265,11 @@ def basinhopping(
     # start main iteration loop
     count, i = 0, 0
     message = ["requested number of basinhopping iterations completed" " successfully"]
+
     grad_norm_at_min = 0.0
+    if use_jac:
+        _, grad_val = func(bh.x)
+        grad_norm_at_min = np.linalg.norm(grad_val)
 
     with progress:
         for i in range(niter):
@@ -282,3 +327,6 @@ def basinhopping(
     res.success = res.lowest_optimization_result.success
 
     return res
+
+
+__all__ = ["basinhopping"]

{better_optimize-0.1 → better_optimize-0.1.2}/better_optimize/minimize.py

@@ -113,3 +113,6 @@ def minimize(
 
     optimizer_result = optimizer_early_stopping_wrapper(f_optim)
     return optimizer_result
+
+
+__all__ = ["minimize"]

{better_optimize-0.1 → better_optimize-0.1.2}/better_optimize/root.py

@@ -100,3 +100,6 @@ def root(
 
     optimizer_result = optimizer_early_stopping_wrapper(f_optim)
     return optimizer_result
+
+
+__all__ = ["root"]

{better_optimize-0.1 → better_optimize-0.1.2}/better_optimize/wrapper.py

@@ -15,6 +15,7 @@ from rich.progress import (
     TimeElapsedColumn,
 )
 from rich.table import Column
+from scipy.optimize import OptimizeResult
 
 from better_optimize.utilities import ToggleableProgress
 
@@ -188,10 +189,12 @@ def optimizer_early_stopping_wrapper(f_optim: partial):
         except (KeyboardInterrupt, StopIteration):
             # Teardown the progress bar if necessary, then forward the error
             final_value = objective.previous_x
-            res = {"x": final_value, "fun": objective.step(final_value)}
-            _log.warning(
-                "Execution interrupted and callback failed! Returning partial results as a dictionary "
-                "(not a scipy.optimize.OptimizeResult)."
+            res = OptimizeResult(
+                x=final_value,
+                fun=objective.previous_x,
+                success=False,
+                message="`StopIteration` or `KeyboardInterrupt` raised -- optimization stopped "
+                "prematurely.",
             )
         except Exception as e:
             raise e

{better_optimize-0.1 → better_optimize-0.1.2}/better_optimize.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-optimize
-Version: 0.1
+Version: 0.1.2
 Summary: A drop-in replacement for scipy optimize functions with quality of life improvements
 License: MIT License
 Project-URL: Homepage, https://github.com/jessegrabowski/better_optimize

{better_optimize-0.1 → better_optimize-0.1.2}/better_optimize.egg-info/requires.txt

@@ -1,5 +1,5 @@
 numpy
-scipy
+scipy>=1.15
 rich
 
 [tests]

{better_optimize-0.1 → better_optimize-0.1.2}/pyproject.toml

@@ -27,7 +27,7 @@ classifiers =[
 
 dependencies = [
   'numpy',
-  'scipy',
+  'scipy>=1.15',
   'rich',
 ]