iwopy 0.1.9__py3-none-any.whl → 0.2.3__py3-none-any.whl

iwopy/interfaces/pygmo/problem.py

@@ -7,34 +7,25 @@ class UDP:
     """
     Generic Problem to Pygmo UserDefinedProblem adapter
 
-    Parameters
-    ----------
-    problem : iwopy.Problem
-        The problem to optimize
-    c_tol : float
-        Constraint tolerance
-    pop : bool
-        Vectorized fitness computation
-    verbosity : int
-        The verbosity level, 0 = silent
-
     Attributes
     ----------
-    problem : iwopy.Problem
+    problem: iwopy.Problem
         The problem to optimize
-    n_vars_all :  int
+    n_vars_all:  int
         The sum of int and float variable counts
-    n_fitness : int
+    n_fitness: int
         The sum of objective and constraint counts
-    c_tol : list of float
+    c_tol: list of float
         Constraint tolerances
-    values : numpy.ndarray
+    values: numpy.ndarray
         The function values, shape: (n_fitness,)
-    pop : bool
+    pop: bool
         Vectorized fitness computation
-    verbosity : int
+    verbosity: int
         The verbosity level, 0 = silent
 
+    :group: interfaces.pygmo
+
     """
 
     def __init__(
@@ -43,7 +34,21 @@ class UDP:
         pop=False,
         verbosity=0,
     ):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        problem: iwopy.Problem
+            The problem to optimize
+        c_tol: float
+            Constraint tolerance
+        pop: bool
+            Vectorized fitness computation
+        verbosity: int
+            The verbosity level, 0 = silent
 
+        """
         self.problem = problem
         self.n_vars_all = problem.n_vars_float + problem.n_vars_int
         self.n_fitness = problem.n_objectives + problem.n_constraints
@@ -215,7 +220,7 @@ class UDP:
         ----------
         pygmo_pop: pygmo.Population
             The results from the solver
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns

iwopy/interfaces/pymoo/__init__.py

@@ -1 +1,4 @@
-from .optimizer import Optimizer_pymoo
+from .imports import load
+from .factory import Factory
+from .optimizer import Optimizer_pymoo, DefaultCallbackTemplate
+from .optimizer import SingleObjProblemTemplate, MultiObjProblemTemplate

iwopy/interfaces/pymoo/factory.py

@@ -4,6 +4,9 @@ from . import imports
 class Factory:
     """
     A factory for pymoo components
+
+    :group: interfaces.pymoo
+
     """
 
     def __init__(self, pymoo_problem, verbosity):
@@ -182,6 +185,9 @@ class Factory:
         return out
 
     def get_termination(self, term_pars):
+        """
+        Termination factory function
+        """
 
         if isinstance(term_pars, tuple):
             return term_pars

iwopy/interfaces/pymoo/imports.py

@@ -27,6 +27,17 @@ loaded = False
 
 
 def load(verbosity=1):
+    """
+    Loads the pymoo package dynamically
+
+    Parameters
+    ----------
+    verbosity: int
+        The verbosity level, 0 = silent
+
+    :group: interfaces.pymoo
+
+    """
 
     global Callback, Problem, Real, Integer, IntegerRandomSampling, FloatRandomSampling
     global BinaryRandomSampling, PermutationRandomSampling, LatinHypercubeSampling, SBX

iwopy/interfaces/pymoo/optimizer.py

@@ -2,74 +2,101 @@ import numpy as np
 import matplotlib.pyplot as plt
 
 from iwopy.core import Optimizer
-from .problem import get_single_obj_class, get_multi_obj_class
+from .problem import SingleObjProblemTemplate, MultiObjProblemTemplate
 from .factory import Factory
 from . import imports
 
 
-def get_default_callback_class(verbosity=1):
+class DefaultCallbackTemplate:
+    """
+    Template for the default callback
 
-    imports.load(verbosity)
+    :group: interfaces.pymoo
 
-    class DefaultCallback(imports.Callback):
-        def __init__(self):
-            super().__init__()
-            self.data["f_best"] = None
-            self.data["cv_best"] = None
+    """
 
-        def notify(self, algorithm):
-            fvals = algorithm.pop.get("F")
-            cvals = algorithm.pop.get("CV")
-            n_obj = fvals.shape[1]
-            n_con = cvals.shape[1]
-            i = np.argmin(fvals, axis=0)
-            if self.data["f_best"] is None:
-                self.data["f_best"] = fvals[None, i, range(n_obj)]
-                self.data["cv_best"] = cvals[None, i, range(n_con)]
-            else:
-                self.data["f_best"] = np.append(
-                    self.data["f_best"], fvals[None, i, range(n_obj)], axis=0
-                )
-                self.data["cv_best"] = np.append(
-                    self.data["cv_best"], cvals[None, i, range(n_con)], axis=0
-                )
+    def __init__(self):
+        """
+        Constructor
+        """
+        self.data["f_best"] = None
+        self.data["cv_best"] = None
+
+    def notify(self, algorithm):
+        fvals = algorithm.pop.get("F")
+        cvals = algorithm.pop.get("CV")
+        n_obj = fvals.shape[1]
+        n_con = cvals.shape[1]
+        i = np.argmin(fvals, axis=0)
+        if self.data["f_best"] is None:
+            self.data["f_best"] = fvals[None, i, range(n_obj)]
+            self.data["cv_best"] = cvals[None, i, range(n_con)]
+        else:
+            self.data["f_best"] = np.append(
+                self.data["f_best"], fvals[None, i, range(n_obj)], axis=0
+            )
+            self.data["cv_best"] = np.append(
+                self.data["cv_best"], cvals[None, i, range(n_con)], axis=0
+            )
+
+    @classmethod
+    def get_class(cls):
+        """
+        Creates the class, dynamically derived from pymoo.Callback
+        """
+        imports.load()
+        attrb = {v: d for v, d in cls.__dict__.items()}
+        init0 = cls.__init__
+
+        def init1(self):
+            imports.Callback.__init__(self)
+            init0(self)
 
-    return DefaultCallback
+        attrb["__init__"] = init1
+        attrb["__doc__"] = "The default callback"
+        del attrb["get_class"]
+        return type("DefaultCallback", (imports.Callback,), attrb)()
 
 
 class Optimizer_pymoo(Optimizer):
     """
     Interface to the pymoo optimization solver.
 
-    Parameters
-    ----------
-    problem : iwopy.Problem
-        The problem to optimize
-    problem_pars : dict
-        Parameters for the problem
-    algo_pars : dict
-        Parameters for the alorithm
-    setup_pars : dict
-        Parameters for the calculation setup
-
     Attributes
     ----------
-    problem_pars : dict
+    problem_pars: dict
         Parameters for the problem
-    algo_pars : dict
+    algo_pars: dict
         Parameters for the alorithm
-    setup_pars : dict
+    setup_pars: dict
         Parameters for the calculation setup
-    term_pars : dict
+    term_pars: dict
         Parameters for the termination conditions
-    pymoo_problem : iwopy.interfaces.pymoo.SingleObjProblem
+    pymoo_problem: iwopy.interfaces.pymoo.SingleObjProblem
         The pygmo problem
-    algo : pygmo.algo
+    algo: pygmo.algo
         The pygmo algorithm
 
+    :group: interfaces.pymoo
+
     """
 
     def __init__(self, problem, problem_pars, algo_pars, setup_pars={}, term_pars={}):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        problem: iwopy.Problem
+            The problem to optimize
+        problem_pars: dict
+            Parameters for the problem
+        algo_pars: dict
+            Parameters for the alorithm
+        setup_pars: dict
+            Parameters for the calculation setup
+
+        """
         super().__init__(problem)
 
         self.problem_pars = problem_pars
@@ -124,16 +151,16 @@ class Optimizer_pymoo(Optimizer):
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """
         if self.problem.n_objectives <= 1:
-            self.pymoo_problem = get_single_obj_class(verbosity)(
+            self.pymoo_problem = SingleObjProblemTemplate.get_class()(
                 self.problem, **self.problem_pars
             )
         else:
-            self.pymoo_problem = get_multi_obj_class(verbosity)(
+            self.pymoo_problem = MultiObjProblemTemplate.get_class()(
                 self.problem, **self.problem_pars
             )
 
@@ -152,9 +179,9 @@ class Optimizer_pymoo(Optimizer):
 
         Parameters
         ----------
-        callback : pymoo.Callback, optional
+        callback: pymoo.Callback, optional
             The callback
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
@@ -164,7 +191,7 @@ class Optimizer_pymoo(Optimizer):
 
         """
         if callback == "default":
-            callback = get_default_callback_class(verbosity)()
+            callback = DefaultCallbackTemplate.get_class()
 
         # check problem initialization:
         super().solve()