DFO-LS 1.5.2__py3-none-any.whl → 1.5.4__py3-none-any.whl

{DFO_LS-1.5.2.dist-info → DFO_LS-1.5.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: DFO-LS
-Version: 1.5.2
+Version: 1.5.4
 Summary: A flexible derivative-free solver for (bound constrained) nonlinear least-squares minimization
 Author-email: Lindon Roberts <lindon.roberts@sydney.edu.au>
 Maintainer-email: Lindon Roberts <lindon.roberts@sydney.edu.au>
@@ -33,14 +33,14 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: setuptools
 Requires-Dist: numpy
-Requires-Dist: scipy >=1.11
+Requires-Dist: scipy>=1.11
 Requires-Dist: pandas
 Provides-Extra: dev
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: Sphinx ; extra == 'dev'
-Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: Sphinx; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
 Provides-Extra: trustregion
-Requires-Dist: trustregion >=1.1 ; extra == 'trustregion'
+Requires-Dist: trustregion>=1.1; extra == "trustregion"
 
 ===================================================
 DFO-LS: Derivative-Free Optimizer for Least-Squares

DFO_LS-1.5.4.dist-info/RECORD

@@ -0,0 +1,14 @@
+dfols/__init__.py,sha256=wOAEAlWyt7AEg1wLDbhf5cfdoL2cXGoR8BzF4_2rUMA,1621
+dfols/controller.py,sha256=Jffyao_z7wcQf1WEQtv2smnNew8HXGguWuUPLbgVuCc,52487
+dfols/diagnostic_info.py,sha256=kEcFCjD2rk39XRa90ocEaQvJWc0wj_ZPpQkOulVIM-k,6106
+dfols/hessian.py,sha256=sExx4J4KoGwHItbthX2odosB2ONbQFvLdlcod7PIh4k,4262
+dfols/model.py,sha256=1Npj3fJvMv66bKu_RIzLLI-2tyzPWOsKuyv-YUjcv2c,20711
+dfols/params.py,sha256=GzJGO0TByH1X3B0NbLOCOqmYG8dRiKPKjjX7or_fOqI,18342
+dfols/solver.py,sha256=psKOBi9F8PKdECyu7aS6fpzhN86DnYjFRvzX7XAFoPA,66788
+dfols/trust_region.py,sha256=JbHLBDw7H88a3cIMuialh7kpMNGjL3Lp9JsjrBNpDWQ,28231
+dfols/util.py,sha256=XYb42bc5X9nJtFT27sx6_tD_EcBbqOnCCjKy-1wLJxY,10725
+DFO_LS-1.5.4.dist-info/LICENSE.txt,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+DFO_LS-1.5.4.dist-info/METADATA,sha256=Nm2dZQMPC3fa0U5MR_TXFpt_MuucKuMGSpAlWeco81c,8063
+DFO_LS-1.5.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+DFO_LS-1.5.4.dist-info/top_level.txt,sha256=UfxRhaDN8HQx2_l17KbrDrERJ90OCN7VKkDMpYYbRLU,6
+DFO_LS-1.5.4.dist-info/RECORD,,

{DFO_LS-1.5.2.dist-info → DFO_LS-1.5.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

dfols/__init__.py

@@ -39,9 +39,9 @@ alternative licensing.
 from __future__ import absolute_import, division, print_function, unicode_literals
 
 # DFO-LS version
-__version__ = '1.5.2'
+__version__ = '1.5.4'
 
 # Main solver & exit flags
 from .solver import *
-__all__ = ['solve']
+__all__ = ['solve', 'OptimResults']
 

dfols/solver.py

@@ -32,6 +32,7 @@ import logging
 from math import sqrt
 import numpy as np
 import os
+import pandas as pd
 import scipy.linalg as LA
 import scipy.stats as STAT
 import warnings
@@ -41,7 +42,7 @@ from .diagnostic_info import *
 from .params import *
 from .util import *
 
-__all__ = ['solve']
+__all__ = ['solve', 'OptimResults']
 
 module_logger = logging.getLogger(__name__) 
 
@@ -92,12 +93,60 @@ class OptimResults(object):
             if self.diagnostic_info is not None:
                 output += "Diagnostic information available; check self.diagnostic_info\n"
             output += "Solution xmin was evaluation point %g\n" % self.xmin_eval_num
-            if len(self.jacmin_eval_nums) < 100:
+            if self.jacmin_eval_nums is not None and len(self.jacmin_eval_nums) < 100:
                 output += "Approximate Jacobian formed using evaluation points %s\n" % str(self.jacmin_eval_nums)
+            elif self.jacmin_eval_nums is None:
+                output += "Approximate Jacobian not formed using problem information, disregard\n"
+            else:
+                output += "Not showing Jacobian evaluation points because it is too long; check self.jacmin_eval_nums\n"
         output += "Exit flag = %g\n" % self.flag
         output += "%s\n" % self.msg
         output += "****************************\n"
         return output
+    
+    def to_dict(self, replace_nan=True):
+        # Convert to a serializable dict object suitable for saving in a json file
+        # If replace_nan=True, convert all NaN entries to None
+        soln_dict = {}
+        soln_dict['x'] = self.x.tolist() if self.x is not None else None
+        soln_dict['resid'] = self.resid.tolist() if self.resid is not None else None
+        soln_dict['obj'] = float(self.obj)
+        soln_dict['jacobian'] = self.jacobian.tolist() if self.jacobian is not None else None
+        soln_dict['nf'] = int(self.nf)
+        soln_dict['nx'] = int(self.nx)
+        soln_dict['nruns'] = int(self.nruns)
+        soln_dict['flag'] = int(self.flag)
+        soln_dict['msg'] = str(self.msg)
+        soln_dict['diagnostic_info'] = self.diagnostic_info.to_dict() if self.diagnostic_info is not None else None
+        soln_dict['xmin_eval_num'] = int(self.xmin_eval_num)
+        soln_dict['jacmin_eval_nums'] = self.jacmin_eval_nums.tolist() if self.jacmin_eval_nums is not None else None
+        if replace_nan:
+            return replace_nan_with_none(soln_dict)
+        else:
+            return soln_dict
+    
+    @staticmethod
+    def from_dict(soln_dict):
+        # Take a dict object containing OptimResults information, and return the relevant OptimResults object
+        # Input soln_dict should come from soln.to_dict()
+        # Note: np.array(mylist, dtype=float) automatically converts None to NaN
+        x = np.array(soln_dict['x'], dtype=float) if soln_dict['x'] is not None else None
+        resid = np.array(soln_dict['resid'], dtype=float) if soln_dict['resid'] is not None else None
+        obj = soln_dict['obj']
+        jacobian = np.array(soln_dict['jacobian'], dtype=float) if soln_dict['jacobian'] is not None else None
+        nf = soln_dict['nf']
+        nx = soln_dict['nx']
+        nruns = soln_dict['nruns']
+        flag = soln_dict['flag']
+        msg = soln_dict['msg']
+        xmin_eval_num = soln_dict['xmin_eval_num']
+        jacmin_eval_nums = np.array(soln_dict['jacmin_eval_nums'], dtype=int) if soln_dict['jacmin_eval_nums'] is not None else None
+        
+        soln = OptimResults(x, resid, obj, jacobian, nf, nx, nruns, flag, msg, xmin_eval_num, jacmin_eval_nums)
+        
+        if soln_dict['diagnostic_info'] is not None:
+            soln.diagnostic_info = pd.DataFrame.from_dict(soln_dict['diagnostic_info'])
+        return soln
 
 
 def solve_main(objfun, x0, argsf, xl, xu, projections, npt, rhobeg, rhoend, maxfun, nruns_so_far, nf_so_far, nx_so_far, nsamples, params,
@@ -148,7 +197,9 @@ def solve_main(objfun, x0, argsf, xl, xu, projections, npt, rhobeg, rhoend, maxf
                 exit_info = ExitInformation(EXIT_SUCCESS, "Objective is sufficiently small")
 
         if exit_info is not None:
-            return x0, r0_avg, sumsq(r0_avg), None, num_samples_run, nf, nx, nruns_so_far+1, exit_info, diagnostic_info
+            xmin_eval_num = 0
+            jacmin_eval_nums = np.array([0], dtype=int)
+            return x0, r0_avg, sumsq(r0_avg), None, num_samples_run, nf, nx, nruns_so_far+1, exit_info, diagnostic_info, xmin_eval_num, jacmin_eval_nums
 
     else:  # have old r0 information (e.g. from previous restart), use this instead
 

dfols/util.py

@@ -26,13 +26,14 @@ alternative licensing.
 from __future__ import absolute_import, division, print_function, unicode_literals
 
 import logging
+import math
 import numpy as np
 import scipy.linalg as LA
 import sys
 
 
 __all__ = ['sumsq', 'eval_least_squares_with_regularisation', 'model_value', 'random_orthog_directions_within_bounds',
-           'random_directions_within_bounds', 'apply_scaling', 'remove_scaling', 'pbox', 'pball', 'dykstra', 'qr_rank']
+           'random_directions_within_bounds', 'apply_scaling', 'remove_scaling', 'pbox', 'pball', 'dykstra', 'qr_rank', 'replace_nan_with_none']
 
 module_logger = logging.getLogger(__name__) 
 
@@ -268,3 +269,15 @@ def qr_rank(A,tol=1e-15):
     D = np.abs(np.diag(R))
     rank = np.sum(D > tol) 
     return rank, D
+
+
+def replace_nan_with_none(d):
+    # Replace Nan values in a dict/list with None (used for JSON serializing of OptimResults object)
+    if isinstance(d, dict):
+        return {k: replace_nan_with_none(v) for k, v in d.items()}
+    elif isinstance(d, list):
+        return [replace_nan_with_none(i) for i in d]
+    elif isinstance(d, float) and math.isnan(d):
+        return None
+    else:
+        return d

DFO_LS-1.5.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-dfols/__init__.py,sha256=EGaYvogmtsNfmB_MVMFwglCwZbhl8O18rsOldwjIr5Q,1605
-dfols/controller.py,sha256=Jffyao_z7wcQf1WEQtv2smnNew8HXGguWuUPLbgVuCc,52487
-dfols/diagnostic_info.py,sha256=kEcFCjD2rk39XRa90ocEaQvJWc0wj_ZPpQkOulVIM-k,6106
-dfols/hessian.py,sha256=sExx4J4KoGwHItbthX2odosB2ONbQFvLdlcod7PIh4k,4262
-dfols/model.py,sha256=1Npj3fJvMv66bKu_RIzLLI-2tyzPWOsKuyv-YUjcv2c,20711
-dfols/params.py,sha256=GzJGO0TByH1X3B0NbLOCOqmYG8dRiKPKjjX7or_fOqI,18342
-dfols/solver.py,sha256=tvDdZgQ3AtybIZCTJf2DvGo6YvbV1NNACrzT2RUF000,63910
-dfols/trust_region.py,sha256=JbHLBDw7H88a3cIMuialh7kpMNGjL3Lp9JsjrBNpDWQ,28231
-dfols/util.py,sha256=efGVAKPb7YrHya1IOgyzacwa_h0u2jHHs5FhuxUlYDg,10282
-DFO_LS-1.5.2.dist-info/LICENSE.txt,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
-DFO_LS-1.5.2.dist-info/METADATA,sha256=eTT5r3VaND81vjaSdiW8AcUn6HsISxXAgV5UNXAHnBk,8069
-DFO_LS-1.5.2.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-DFO_LS-1.5.2.dist-info/top_level.txt,sha256=UfxRhaDN8HQx2_l17KbrDrERJ90OCN7VKkDMpYYbRLU,6
-DFO_LS-1.5.2.dist-info/RECORD,,