better-optimize 0.0.3__tar.gz → 0.0.4__tar.gz

{better_optimize-0.0.3 → better_optimize-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better_optimize
-Version: 0.0.3
+Version: 0.0.4
 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.0.3 → better_optimize-0.0.4}/better_optimize/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-08-19T21:06:06+0800",
+ "date": "2024-08-21T05:49:44+0200",
  "dirty": false,
  "error": null,
- "full-revisionid": "6fa51b7ab8759ba1dbd944c0839b97719358c2a2",
- "version": "0.0.3"
+ "full-revisionid": "f51ee88e4ef9f5f8708d8a8e910e04dd4d6e3bde",
+ "version": "0.0.4"
 }
 '''  # END VERSION_JSON
 

{better_optimize-0.0.3 → better_optimize-0.0.4}/better_optimize/constants.py

@@ -37,6 +37,7 @@ MINIMIZE_MODE_KWARGS = {
         "uses_grad": False,
         "uses_hess": False,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: 200 * n,
         "valid_options": [
             "disp",
             "maxiter",
@@ -53,12 +54,14 @@ MINIMIZE_MODE_KWARGS = {
         "uses_grad": False,
         "uses_hess": False,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: 1000 * n,
         "valid_options": ["disp", "xtol", "ftol", "maxiter", "maxfev", "direc", "return_all"],
     },
     "CG": {
         "uses_grad": True,
         "uses_hess": False,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: 200 * n,
         "valid_options": [
             "disp",
             "maxiter",
@@ -75,6 +78,7 @@ MINIMIZE_MODE_KWARGS = {
         "uses_grad": True,
         "uses_hess": False,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: 200 * n,
         "valid_options": [
             "disp",
             "maxiter",
@@ -93,12 +97,14 @@ MINIMIZE_MODE_KWARGS = {
         "uses_grad": True,
         "uses_hess": True,
         "uses_hessp": True,
+        "f_maxiter_default": lambda n: 200 * n,
         "valid_options": ["disp", "xtol", "maxiter", "eps", "return_all", "c1", "c2"],
     },
     "L-BFGS-B": {
         "uses_grad": True,
         "uses_hess": False,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: 200 * n,
         "valid_options": [
             "disp",
             "maxcor",
@@ -116,6 +122,7 @@ MINIMIZE_MODE_KWARGS = {
         "uses_grad": True,
         "uses_hess": False,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: max(100, 10 * n),
         "valid_options": [
             "eps",
             "scale",
@@ -138,12 +145,14 @@ MINIMIZE_MODE_KWARGS = {
         "uses_grad": False,
         "uses_hess": False,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: 1000,
         "valid_options": ["rhobeg", "tol", "disp", "maxiter", "catol"],
     },
     "SLSQP": {
         "uses_grad": True,
         "uses_hess": False,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: 100,
         "valid_options": [
             "ftol",
             "eps",
@@ -156,6 +165,7 @@ MINIMIZE_MODE_KWARGS = {
         "uses_grad": True,
         "uses_hess": True,
         "uses_hessp": True,
+        "f_maxiter_default": lambda n: 1000,
         "valid_options": [
             "gtol",
             "xtol",
@@ -176,52 +186,47 @@ MINIMIZE_MODE_KWARGS = {
         "uses_grad": True,
         "uses_hess": True,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: 200 * n,
         "valid_options": ["initial_trust_radius", "max_trust_radius", "eta", "gtol"],
     },
     "trust-ncg": {
         "uses_grad": True,
         "uses_hess": True,
         "uses_hessp": True,
+        "f_maxiter_default": lambda n: 200 * n,
         "valid_options": ["initial_trust_radius", "max_trust_radius", "eta", "gtol"],
     },
     "trust-exact": {
         "uses_grad": True,
         "uses_hess": True,
         "uses_hessp": False,
+        "f_maxiter_default": lambda n: 200 * n,
         "valid_options": ["initial_trust_radius", "max_trust_radius", "eta", "gtol"],
     },
     "trust-krylov": {
         "uses_grad": True,
         "uses_hess": True,
         "uses_hessp": True,
+        "f_maxiter_default": lambda n: 200 * n,
         "valid_options": ["inexact"],
     },
 }
 
-root_method = Literal[
-    "hybr",
-    "lm",
-    "broyden1",
-    "broyden2",
-    "anderson",
-    "linearmixing",
-    "diagbroyden",
-    "excitingmixing",
-    "krylov",
-    "df-sane",
-]
 
 ROOT_MODE_KWARGS = {
     "hybr": {
         "uses_jac": True,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": ["col_deriv", "xtol", "maxfev", "band", "eps", "factor", "diag"],
     },
     "lm": {
         "uses_jac": True,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": ["col_deriv", "ftol", "xtol", "gtol", "maxiter", "eps", "factor", "diag"],
     },
     "broyden1": {
         "uses_jac": False,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": [
             "nit",
             "disp",
@@ -239,6 +244,7 @@ ROOT_MODE_KWARGS = {
     },
     "broyden2": {
         "uses_jac": False,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": [
             "nit",
             "disp",
@@ -256,6 +262,7 @@ ROOT_MODE_KWARGS = {
     },
     "anderson": {
         "uses_jac": False,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": [
             "nit",
             "disp",
@@ -272,6 +279,7 @@ ROOT_MODE_KWARGS = {
     },
     "linearmixing": {
         "uses_jac": False,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": [
             "nit",
             "disp",
@@ -288,6 +296,7 @@ ROOT_MODE_KWARGS = {
     },
     "diagbroyden": {
         "uses_jac": False,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": [
             "nit",
             "disp",
@@ -304,6 +313,7 @@ ROOT_MODE_KWARGS = {
     },
     "excitingmixing": {
         "uses_jac": False,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": [
             "nit",
             "disp",
@@ -320,6 +330,7 @@ ROOT_MODE_KWARGS = {
     },
     "krylov": {
         "uses_jac": False,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": [
             "nit",
             "disp",
@@ -343,6 +354,7 @@ ROOT_MODE_KWARGS = {
     },
     "df-sane": {
         "uses_jac": False,
+        "f_maxiter_default": lambda n: 100 * (n + 1),
         "valid_options": [
             "ftol",
             "fatol",

{better_optimize-0.0.3 → better_optimize-0.0.4}/better_optimize/minimize.py

@@ -72,7 +72,7 @@ def minimize(
     optimizer_kwargs["options"] = options
 
     optimizer_kwargs = kwargs_to_options(optimizer_kwargs, method)
-    maxiter, optimizer_kwargs = determine_maxiter(optimizer_kwargs, method)
+    maxiter, optimizer_kwargs = determine_maxiter(optimizer_kwargs, method, len(x0))
     optimizer_kwargs = determine_tolerance(optimizer_kwargs, method)
 
     # Test hessian function -- if it returns a LinearOperator, it can't be used inside the wrapper

{better_optimize-0.0.3 → better_optimize-0.0.4}/better_optimize/root.py

@@ -71,7 +71,7 @@ def root(
     optimizer_kwargs = kwargs_to_options(optimizer_kwargs, method)
     optimizer_kwargs = kwargs_to_jac_options(optimizer_kwargs, method)
 
-    maxiter, optimizer_kwargs = determine_maxiter(optimizer_kwargs, method)
+    maxiter, optimizer_kwargs = determine_maxiter(optimizer_kwargs, method, len(x0))
     optimizer_kwargs = determine_tolerance(optimizer_kwargs, method)
 
     objective = ObjectiveWrapper(

{better_optimize-0.0.3 → better_optimize-0.0.4}/better_optimize/utilities.py

@@ -36,7 +36,7 @@ def validate_provided_functions_minimize(
     verbose=True,
 ) -> None:
     has_grad, has_hess, has_hessp = map(lambda f: f is not None, [f_grad, f_hess, f_hessp])
-    uses_grad, uses_hess, uses_hessp, _ = MINIMIZE_MODE_KWARGS[method].values()
+    uses_grad, uses_hess, uses_hessp, *_ = MINIMIZE_MODE_KWARGS[method].values()
 
     if has_fused_f_and_grad and has_grad:
         _log.warning(
@@ -119,12 +119,19 @@ def check_f_is_fused(f, x0, args):
 
 
 def determine_maxiter(
-    optimizer_kwargs: dict, method: minimize_method | root_method
+    optimizer_kwargs: dict, method: minimize_method | root_method, n_vars
 ) -> tuple[int, dict]:
     MAXITER_KWARGS = ["maxiter", "maxfun", "maxfev"]
-    maxiter = optimizer_kwargs.pop("maxiter", 5000)
-    optimizer_kwargs["options"].update({"maxiter": maxiter})
-    maxiter_kwargs = [x for x in get_option_kwargs(method)["valid_options"] if x in MAXITER_KWARGS]
+    method_info = get_option_kwargs(method)
+    maxiter_kwargs = [x for x in method_info["valid_options"] if x in MAXITER_KWARGS]
+    maxiter_possibilities = [
+        optimizer_kwargs.pop("maxiter", None),
+        *(optimizer_kwargs["options"].get(kwarg) for kwarg in maxiter_kwargs),
+    ]
+    if any(maxiter_possibilities):
+        maxiter = max([x for x in maxiter_possibilities if x is not None])
+    else:
+        maxiter = method_info["f_maxiter_default"](n_vars)
 
     for kwarg in maxiter_kwargs:
         if kwarg not in optimizer_kwargs["options"]:

{better_optimize-0.0.3 → better_optimize-0.0.4}/better_optimize/wrapper.py

@@ -123,12 +123,17 @@ class ObjectiveWrapper:
             value_dict["hess_norm"] = hess_norm
 
         if self.n_eval == 0:
-            self.task = self.progress.add_task("Optimizing", **value_dict)
+            self.task = self.progress.add_task(
+                "Optimizing", total=self.maxeval, refresh=True, **value_dict
+            )
 
         if not completed:
             self.progress.update(self.task, advance=self.update_every, **value_dict)
         else:
-            self.progress.update(self.task, total=self.n_eval, completed=self.n_eval, **value_dict)
+            self.progress.update(
+                self.task, total=self.n_eval, completed=self.n_eval, refresh=True, **value_dict
+            )
+            self.progress.stop()
 
     def initialize_progress_bar(self):
         text_column = TextColumn("{task.description}", table_column=Column(ratio=1))

{better_optimize-0.0.3 → better_optimize-0.0.4}/better_optimize.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-optimize
-Version: 0.0.3
+Version: 0.0.4
 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