iwopy 0.1.8__py3-none-any.whl → 0.2__py3-none-any.whl

iwopy/VERSION

@@ -1 +1 @@
-0.1.8
+0.2

iwopy/__init__.py

@@ -1,3 +1,8 @@
+"""
+Fraunhofer IWES optimization tools in Python
+    
+"""
+
 from .core import Problem, Objective, Constraint, Memory
 from .wrappers import (
     ProblemWrapper,
@@ -13,6 +18,11 @@ from . import interfaces
 from . import benchmarks
 from . import optimizers
 
-from importlib.resources import read_text
+try:
+    from importlib.resources import files
+
+    __version__ = files(__package__).joinpath("VERSION").read_text()
+except ImportError:
+    from importlib.resources import read_text
 
-__version__ = read_text(__package__, "VERSION")
+    __version__ = read_text(__package__, "VERSION")

iwopy/benchmarks/branin/__init__.py

@@ -0,0 +1 @@
+from .branin import BraninObjective, BraninProblem

iwopy/benchmarks/{branin.py → branin/branin.py}

@@ -31,21 +31,26 @@ class BraninObjective(SimpleObjective):
 
     f(x,y) = 0.397887
 
-    Parameters
-    ----------
-    problem: iwopy.Problem
-        The underlying optimization problem
-    ana_deriv : bool
-        Switch for analytical derivatives
-    name: str
-        The function name
+    :group: benchmarks.branin
 
     """
 
     def __init__(self, problem, ana_deriv=False, name="f"):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        problem: iwopy.Problem
+            The underlying optimization problem
+        ana_deriv: bool
+            Switch for analytical derivatives
+        name: str
+            The function name
+
+        """
         super().__init__(problem, name, n_components=1, has_ana_derivs=ana_deriv)
 
-        # Parameters of branin function,
         # (a, b, c, r, s, t)
         self._pars = (
             1,
@@ -82,24 +87,29 @@ class BraninProblem(SimpleProblem):
     """
     Problem definition of benchmark function Branin.
 
-    Parameters
-    ----------
-    name : str
-        The name of the problem
-    ana_deriv : bool
-        Switch for analytical derivatives
-    initial_values : list of float
-        The initial values
-
     Attributes
     ----------
-    initial_values : list of float
+    initial_values: list of float
         The initial values
 
+    :group: benchmarks.branin
+
     """
 
     def __init__(self, name="branin", initial_values=[1.0, 1.0], ana_deriv=False):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        name: str
+            The name of the problem
+        ana_deriv: bool
+            Switch for analytical derivatives
+        initial_values: list of float
+            The initial values
 
+        """
         super().__init__(
             name,
             float_vars={"x": initial_values[0], "y": initial_values[1]},

iwopy/benchmarks/rosenbrock/__init__.py

@@ -0,0 +1 @@
+from .rosenbrock import RosenbrockObjective, RosenbrockProblem

iwopy/benchmarks/{rosenbrock.py → rosenbrock/rosenbrock.py}

@@ -1,5 +1,3 @@
-import numpy as np
-
 from iwopy import SimpleProblem, SimpleObjective
 
 
@@ -25,16 +23,7 @@ class RosenbrockObjective(SimpleObjective):
 
     f(x,y) = 0
 
-    Parameters
-    ----------
-    problem : iwopy.Problem
-        The underlying optimization problem
-    pars : tuple
-        The a, b parameters
-    ana_deriv : bool
-        Switch for analytical derivatives
-    name : str
-        The function name
+    :group: benchmarks.rosenbrock
 
     """
 
@@ -45,9 +34,23 @@ class RosenbrockObjective(SimpleObjective):
         ana_deriv=False,
         name="f",
     ):
+        """
+        Construtor
+
+        Parameters
+        ----------
+        problem: iwopy.Problem
+            The underlying optimization problem
+        pars: tuple
+            The a, b parameters
+        ana_deriv: bool
+            Switch for analytical derivatives
+        name: str
+            The function name
+
+        """
         super().__init__(problem, name, n_components=1, has_ana_derivs=ana_deriv)
 
-        # Parameters of branin function,
         # (a, b)
         self._pars = pars
 
@@ -73,24 +76,13 @@ class RosenbrockProblem(SimpleProblem):
     """
     Problem definition of benchmark function Rosenbrock.
 
-    Parameters
-    ----------
-    lower : list of float
-        The minimal variable values
-    upper : list of float
-        The maximal variable values
-    initial : list of float
-        The initial values
-    ana_deriv : bool
-        Switch for analytical derivatives
-    name : str
-        The name of the problem
-
     Attributes
     ----------
-    initial_values : list of float
+    initial_values: list of float
         The initial values
 
+    :group: benchmarks.rosenbrock
+
     """
 
     def __init__(
@@ -101,7 +93,23 @@ class RosenbrockProblem(SimpleProblem):
         ana_deriv=False,
         name="rosenbrock",
     ):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        lower: list of float
+            The minimal variable values
+        upper: list of float
+            The maximal variable values
+        initial: list of float
+            The initial values
+        ana_deriv: bool
+            Switch for analytical derivatives
+        name: str
+            The name of the problem
 
+        """
         super().__init__(
             name,
             float_vars={"x": initial[0], "y": initial[1]},

iwopy/core/base.py

@@ -2,19 +2,25 @@ class Base:
     """
     Generic base for various iwopy objects.
 
-    Parameters
-    ----------
-    name : str
-        The name
-
     Attributes
     ----------
-    name : str
+    name: str
         The name
 
+    :group: core
+
     """
 
     def __init__(self, name):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        name: str
+            The name
+
+        """
         self.name = name
         self._initialized = False
         if name is None:
@@ -53,7 +59,7 @@ class Base:
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """
@@ -65,7 +71,7 @@ class Base:
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """

iwopy/core/constraint.py

@@ -8,19 +8,25 @@ class Constraint(OptFunction):
     Abstract base class for optimization
     constraints.
 
-    Parameters
-    ----------
-    tol : float
-        The tolerance for constraint violations
-
     Attributes
     ----------
-    tol : float
+    tol: float
         The tolerance for constraint violations
 
+    :group: core
+
     """
 
     def __init__(self, *args, tol=1e-5, **kwargs):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        tol: float
+            The tolerance for constraint violations
+
+        """
         super().__init__(*args, **kwargs)
         self.tol = tol
 
@@ -32,9 +38,9 @@ class Constraint(OptFunction):
 
         Returns
         -------
-        min : np.array
+        min: np.array
             The lower bounds, shape: (n_components,)
-        max : np.array
+        max: np.array
             The upper bounds, shape: (n_components,)
 
         """
@@ -50,13 +56,13 @@ class Constraint(OptFunction):
 
         Parameters
         ----------
-        constraint_values : np.array
+        constraint_values: np.array
             The constraint values, shape: (n_components,)
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
-        values : np.array
+        values: np.array
         -------
             The boolean result, shape: (n_components,)
 
@@ -82,14 +88,14 @@ class Constraint(OptFunction):
 
         Parameters
         ----------
-        constraint_values : np.array
+        constraint_values: np.array
             The constraint values, shape: (n_pop, n_components,)
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The boolean result, shape: (n_pop, n_components)
 
         """

iwopy/core/function.py

@@ -10,36 +10,13 @@ class OptFunction(Base, metaclass=ABCMeta):
     Abstract base class for functions
     that calculate scalars based on a problem.
 
-    Parameters
-    ----------
-    problem: iwopy.Problem
-        The underlying optimization problem
-    name: str
-        The function name
-    n_vars_int : int, optional
-        The number of integer variables. If not specified
-        it is assumed that the function depends on all
-        problem int variables
-    n_vars_float : int, optional
-        The number of float variables. If not specified
-        it is assumed that the function depends on all
-        problem float variables
-    vnames_int : list of str, optional
-        The integer variable names. Useful for mapping
-        function variables to problem variables, otherwise
-        map by integer or default name
-    vnames_float : list of str, optional
-        The float variable names. Useful for mapping
-        function variables to problem variables, otherwise
-        map by integer or default name
-    cnames : list of str, optional
-        The names of the components
-
     Attributes
     ----------
     problem: iwopy.Problem
         The underlying optimization problem
 
+    :group: core
+
     """
 
     def __init__(
@@ -52,6 +29,35 @@ class OptFunction(Base, metaclass=ABCMeta):
         vnames_float=None,
         cnames=None,
     ):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        problem: iwopy.Problem
+            The underlying optimization problem
+        name: str
+            The function name
+        n_vars_int: int, optional
+            The number of integer variables. If not specified
+            it is assumed that the function depends on all
+            problem int variables
+        n_vars_float: int, optional
+            The number of float variables. If not specified
+            it is assumed that the function depends on all
+            problem float variables
+        vnames_int: list of str, optional
+            The integer variable names. Useful for mapping
+            function variables to problem variables, otherwise
+            map by integer or default name
+        vnames_float: list of str, optional
+            The float variable names. Useful for mapping
+            function variables to problem variables, otherwise
+            map by integer or default name
+        cnames: list of str, optional
+            The names of the components
+
+        """
         super().__init__(name)
 
         self.problem = problem
@@ -97,7 +103,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """
@@ -124,7 +130,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Returns
         -------
-        names : list of str
+        names: list of str
             The component names
 
         """
@@ -137,7 +143,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Returns
         -------
-        names : list of str
+        names: list of str
             The integer variable names
 
         """
@@ -150,7 +156,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Returns
         -------
-        n : int
+        n: int
             The number of int variables
 
         """
@@ -163,7 +169,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Returns
         -------
-        names : list of str
+        names: list of str
             The float variable names
 
         """
@@ -176,7 +182,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Returns
         -------
-        n : int
+        n: int
             The number of float variables
 
         """
@@ -189,7 +195,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Returns
         -------
-        deps : numpy.ndarray of bool
+        deps: numpy.ndarray of bool
             The dependencies of components on function
             variables, shape: (n_components, n_vars_int)
 
@@ -203,7 +209,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Returns
         -------
-        deps : numpy.ndarray of bool
+        deps: numpy.ndarray of bool
             The dependencies of components on function
             variables, shape: (n_components, n_vars_float)
 
@@ -248,7 +254,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Parameters
         ----------
-        varmap : dict
+        varmap: dict
             The name mapping. Key: old name str,
             Value: new name str
 
@@ -261,7 +267,7 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Parameters
         ----------
-        varmap : dict
+        varmap: dict
             The name mapping. Key: old name str,
             Value: new name str
 
@@ -275,19 +281,19 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        components : list of int, optional
+        components: list of int, optional
             The selected components or None for all
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_sel_components,)
 
         """
@@ -299,19 +305,19 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_pop, n_vars_int)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_pop, n_vars_float)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        components : list of int, optional
+        components: list of int, optional
             The selected components or None for all
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_pop, n_sel_components)
 
         """
@@ -340,19 +346,19 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The optimal integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The optimal float variable values, shape: (n_vars_float,)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_components,)
 
         """
@@ -364,21 +370,21 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values of the final
             generation, shape: (n_pop, n_vars_int)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values of the final
             generation, shape: (n_pop, n_vars_float)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_pop, n_components)
 
         """
@@ -392,18 +398,18 @@ class OptFunction(Base, metaclass=ABCMeta):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
-        var : int
+        var: int
             The index of the differentiation float variable
-        components : list of int
+        components: list of int
             The selected components, or None for all
 
         Returns
         -------
-        deriv : numpy.ndarray
+        deriv: numpy.ndarray
             The derivative values, shape: (n_sel_components,)
 
         """