pydmoo 0.1.2__tar.gz → 0.1.4__tar.gz

{pydmoo-0.1.2 → pydmoo-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydmoo
-Version: 0.1.2
+Version: 0.1.4
 Summary: Dynamic Multi-Objective Optimization in Python (pydmoo).
 Project-URL: Homepage, https://github.com/dynoptimization/pydmoo
 Project-URL: Repository, https://github.com/dynoptimization/pydmoo
@@ -44,5 +44,6 @@ Description-Content-Type: text/markdown
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pydmoo)
 [![PyPI](https://img.shields.io/pypi/v/pydmoo)](https://pypi.org/project/pydmoo/)
 ![Visitors](https://visitor-badge.laobi.icu/badge?page_id=dynoptimization.pydmoo)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
 Please refer to the [documentation](https://dynoptimization.github.io/pydmoo/) for more details.

{pydmoo-0.1.2 → pydmoo-0.1.4}/README.md

@@ -4,5 +4,6 @@
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pydmoo)
 [![PyPI](https://img.shields.io/pypi/v/pydmoo)](https://pypi.org/project/pydmoo/)
 ![Visitors](https://visitor-badge.laobi.icu/badge?page_id=dynoptimization.pydmoo)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
 Please refer to the [documentation](https://dynoptimization.github.io/pydmoo/) for more details.

pydmoo-0.1.4/docs/user-guide/algorithms/algorithms.base.dmoo.dmoead.md

@@ -0,0 +1,13 @@
+# algorithms.base.dmoo.dmoead
+
+::: pydmoo.algorithms.base.dmoo.dmoead
+    options:
+      show_root_heading: false
+      members:
+        - DMOEAD
+        - DMOEADA
+        - DMOEADB
+      show_submodules: true
+      heading_level: 2
+      show_source: true
+      show_category_heading: true

pydmoo-0.1.4/docs/user-guide/algorithms/algorithms.base.dmoo.dmoeadde.md

@@ -0,0 +1,13 @@
+# algorithms.base.dmoo.dmoeadde
+
+::: pydmoo.algorithms.base.dmoo.dmoeadde
+    options:
+      show_root_heading: false
+      members:
+        - DMOEADDE
+        - DMOEADDEA
+        - DMOEADDEB
+      show_submodules: true
+      heading_level: 2
+      show_source: true
+      show_category_heading: true

pydmoo-0.1.4/docs/user-guide/algorithms/algorithms.base.dmoo.dnsga2.md

@@ -0,0 +1,13 @@
+# algorithms.base.dmoo.dnsga2
+
+::: pydmoo.algorithms.base.dmoo.dnsga2
+    options:
+      show_root_heading: false
+      members:
+        - DNSGA2
+        - DNSGA2A
+        - DNSGA2B
+      show_submodules: true
+      heading_level: 2
+      show_source: true
+      show_category_heading: true

pydmoo-0.1.4/docs/user-guide/algorithms/algorithms.classic.moeadde_svr.md

@@ -0,0 +1,9 @@
+# algorithms.classic.moeadde_svr
+
+::: pydmoo.algorithms.classic.moeadde_svr
+    options:
+      show_root_heading: false
+      show_submodules: true
+      heading_level: 2
+      show_source: true
+      show_category_heading: true

pydmoo-0.1.4/docs/user-guide/algorithms/algorithms.knowledge.nsga2_ktmm.md

@@ -0,0 +1,9 @@
+# algorithms.knowledge.nsga2_ktmm
+
+::: pydmoo.algorithms.knowledge.nsga2_ktmm
+    options:
+      show_root_heading: false
+      show_submodules: true
+      heading_level: 2
+      show_source: true
+      show_category_heading: true

pydmoo-0.1.4/docs/user-guide/algorithms/algorithms.learning.nsga2_tr.md

@@ -0,0 +1,9 @@
+# algorithms.learning.nsga2_tr
+
+::: pydmoo.algorithms.learning.nsga2_tr
+    options:
+      show_root_heading: false
+      show_submodules: true
+      heading_level: 2
+      show_source: true
+      show_category_heading: true

pydmoo-0.1.4/docs/user-guide/algorithms.md

@@ -0,0 +1,24 @@
+# Algorithms
+
+## Base Response Mechanisms
+
+- [dnsga2](algorithms/algorithms.base.dmoo.dnsga2.md)
+- [dmoead](algorithms/algorithms.base.dmoo.dmoead.md)
+- [dmoeadde](algorithms/algorithms.base.dmoo.dmoeadde.md)
+
+## Classic Response Mechanisms
+
+- [nsga2_ae](algorithms/algorithms.classic.nsga2_ae.md)
+- [nsga2_pps](algorithms/algorithms.classic.nsga2_pps.md)
+- [moeadde_svr](algorithms/algorithms.classic.moeadde_svr.md)
+
+## Knowledge-Based Response Mechanisms
+
+- [nsga2_ktmm](algorithms/algorithms.knowledge.nsga2_ktmm.md)
+- [nsga2_imkt](algorithms/algorithms.modern.nsga2_imkt.md)
+
+## Learning-Based Response Mechanisms
+
+- [nsga2_tr](algorithms/algorithms.learning.nsga2_tr.md)
+- [nsga2_imkt_lstm](algorithms/algorithms.modern.nsga2_imkt_lstm.md)
+- [nsga2_imkt_clstm](algorithms/algorithms.modern.nsga2_imkt_clstm.md)

{pydmoo-0.1.2 → pydmoo-0.1.4}/pydmoo/algorithms/base/dmoo/dmoead.py

@@ -8,7 +8,21 @@ from pydmoo.algorithms.base.moo.moead import MOEAD
 
 
 class DMOEAD(MOEAD):
-
+    """
+    Dynamic MOEA/D (DMOEAD).
+
+    Extension of MOEAD for dynamic optimization problems.
+
+    Parameters
+    ----------
+    perc_detect_change : float, default=0.1
+        Percentage of population to sample for change detection (0 to 1).
+    eps : float, default=0.0
+        Threshold for change detection. Change is detected when mean squared
+        difference exceeds this value.
+    **kwargs
+        Additional arguments passed to MOEAD parent class.
+    """
     def __init__(self,
                  perc_detect_change=0.1,
                  eps=0.0,
@@ -22,7 +36,15 @@ class DMOEAD(MOEAD):
         assert not problem.has_constraints(), f"{self.__class__.__name__} only works for unconstrained problems."
         return super().setup(problem, **kwargs)
 
-    def _detect_change_sample_part_population(self):
+    def _detect_change_sample_part_population(self) -> bool:
+        """
+        Detect environmental changes by sampling part of the population.
+
+        Returns
+        -------
+        change_detected : bool
+            True if environmental change is detected, False otherwise.
+        """
         pop = self.pop
         X, F = pop.get("X", "F")
 
@@ -40,7 +62,15 @@ class DMOEAD(MOEAD):
         change_detected = delta > self.eps
         return change_detected
 
-    def _next_static_dynamic(self):
+    def _next_static_dynamic(self) -> Population:
+        """
+        Perform next with dynamic change detection and response.
+
+        Returns
+        -------
+        Population
+            Current population after potential response to environmental change.
+        """
         # for dynamic environment
         pop = self.pop
 
@@ -70,11 +100,24 @@ class DMOEAD(MOEAD):
         return pop
 
     def _response_mechanism(self):
-        """Response mechanism."""
+        """
+        Response mechanism for environmental change.
+
+        Returns
+        -------
+        Population
+            Population after applying response strategy.
+
+        Raises
+        ------
+        NotImplementedError
+            Must be implemented by subclasses.
+        """
         raise NotImplementedError
 
 
 class DMOEADA(DMOEAD):
+    """DMOEADA."""
 
     def __init__(self,
                  perc_detect_change=0.1,
@@ -105,6 +148,7 @@ class DMOEADA(DMOEAD):
 
 
 class DMOEADB(DMOEAD):
+    """DMOEADB."""
 
     def __init__(self,
                  perc_detect_change=0.1,

{pydmoo-0.1.2 → pydmoo-0.1.4}/pydmoo/algorithms/base/dmoo/dmoeadde.py

@@ -8,6 +8,21 @@ from pydmoo.algorithms.base.moo.moeadde import MOEADDE
 
 
 class DMOEADDE(MOEADDE):
+    """
+    Dynamic MOEA/D-DE (DMOEADDE).
+
+    Extension of MOEADDE for dynamic optimization problems.
+
+    Parameters
+    ----------
+    perc_detect_change : float, default=0.1
+        Percentage of population to sample for change detection (0 to 1).
+    eps : float, default=0.0
+        Threshold for change detection. Change is detected when mean squared
+        difference exceeds this value.
+    **kwargs
+        Additional arguments passed to MOEADDE parent class.
+    """
 
     def __init__(self,
                  perc_detect_change=0.1,
@@ -22,7 +37,15 @@ class DMOEADDE(MOEADDE):
         assert not problem.has_constraints(), f"{self.__class__.__name__} only works for unconstrained problems."
         return super().setup(problem, **kwargs)
 
-    def _detect_change_sample_part_population(self):
+    def _detect_change_sample_part_population(self) -> bool:
+        """
+        Detect environmental changes by sampling part of the population.
+
+        Returns
+        -------
+        change_detected : bool
+            True if environmental change is detected, False otherwise.
+        """
         pop = self.pop
         X, F = pop.get("X", "F")
 
@@ -40,7 +63,15 @@ class DMOEADDE(MOEADDE):
         change_detected = delta > self.eps
         return change_detected
 
-    def _next_static_dynamic(self):
+    def _next_static_dynamic(self) -> Population:
+        """
+        Perform next with dynamic change detection and response.
+
+        Returns
+        -------
+        Population
+            Current population after potential response to environmental change.
+        """
         # for dynamic environment
         pop = self.pop
 
@@ -69,12 +100,25 @@ class DMOEADDE(MOEADDE):
 
         return pop
 
-    def _response_mechanism(self):
-        """Response mechanism."""
+    def _response_mechanism(self) -> Population:
+        """
+        Response mechanism for environmental change.
+
+        Returns
+        -------
+        Population
+            Population after applying response strategy.
+
+        Raises
+        ------
+        NotImplementedError
+            Must be implemented by subclasses.
+        """
         raise NotImplementedError
 
 
 class DMOEADDEA(DMOEADDE):
+    """DMOEADDEA."""
 
     def __init__(self,
                  perc_detect_change=0.1,
@@ -105,6 +149,7 @@ class DMOEADDEA(DMOEADDE):
 
 
 class DMOEADDEB(DMOEADDE):
+    """DMOEADDEB."""
 
     def __init__(self,
                  perc_detect_change=0.1,

{pydmoo-0.1.2 → pydmoo-0.1.4}/pydmoo/algorithms/base/dmoo/dnsga2.py

@@ -17,10 +17,25 @@ from pydmoo.algorithms.base.moo.nsga2 import NSGA2
 
 
 class DNSGA2(NSGA2):
+    """
+    Dynamic Non-dominated Sorting Genetic Algorithm II (DNSGA2).
+
+    Extension of NSGA2 for dynamic optimization problems.
+
+    Parameters
+    ----------
+    perc_detect_change : float, default=0.1
+        Percentage of population to sample for change detection (0 to 1).
+    eps : float, default=0.0
+        Threshold for change detection. Change is detected when mean squared
+        difference exceeds this value.
+    **kwargs
+        Additional arguments passed to NSGA2 parent class.
+    """
 
     def __init__(self,
-                 perc_detect_change=0.1,
-                 eps=0.0,
+                 perc_detect_change: float = 0.1,
+                 eps: float = 0.0,
                  **kwargs):
 
         super().__init__(**kwargs)
@@ -31,7 +46,15 @@ class DNSGA2(NSGA2):
         assert not problem.has_constraints(), f"{self.__class__.__name__} only works for unconstrained problems."
         return super().setup(problem, **kwargs)
 
-    def _detect_change_sample_part_population(self):
+    def _detect_change_sample_part_population(self) -> bool:
+        """
+        Detect environmental changes by sampling part of the population.
+
+        Returns
+        -------
+        change_detected : bool
+            True if environmental change is detected, False otherwise.
+        """
         pop = self.pop
         X, F = pop.get("X", "F")
 
@@ -49,7 +72,15 @@ class DNSGA2(NSGA2):
         change_detected = delta > self.eps
         return change_detected
 
-    def _infill_static_dynamic(self):
+    def _infill_static_dynamic(self) -> Population:
+        """
+        Perform infill with dynamic change detection and response.
+
+        Returns
+        -------
+        Population
+            Current population after potential response to environmental change.
+        """
         # for dynamic environment
         pop = self.pop
 
@@ -75,17 +106,39 @@ class DNSGA2(NSGA2):
 
         return pop
 
-    def _response_mechanism(self):
-        """Response mechanism."""
+    def _response_mechanism(self) -> Population:
+        """
+        Response mechanism for environmental change.
+
+        Returns
+        -------
+        Population
+            Population after applying response strategy.
+
+        Raises
+        ------
+        NotImplementedError
+            Must be implemented by subclasses.
+        """
         raise NotImplementedError
 
 
 class DNSGA2A(DNSGA2):
+    """DNSGA2A.
+
+    References
+    ----------
+    Deb, K., Rao N., U. B., and Karthik, S. (2007).
+    Dynamic multi-objective optimization and decision-making using modified NSGA-II:
+        A case study on hydro-thermal power scheduling.
+    Evolutionary Multi-Criterion Optimization, 803–817.
+    https://doi.org/10.1007/978-3-540-70928-2_60
+    """
 
     def __init__(self,
-                 perc_detect_change=0.1,
-                 eps=0.0,
-                 perc_diversity=0.3,
+                 perc_detect_change: float = 0.1,
+                 eps: float = 0.0,
+                 perc_diversity: float = 0.3,
                  **kwargs):
         super().__init__(perc_detect_change=perc_detect_change,
                          eps=eps,
@@ -93,7 +146,7 @@ class DNSGA2A(DNSGA2):
 
         self.perc_diversity = perc_diversity
 
-    def _response_mechanism(self):
+    def _response_mechanism(self) -> Population:
         """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
@@ -111,11 +164,21 @@ class DNSGA2A(DNSGA2):
 
 
 class DNSGA2B(DNSGA2):
+    """DNSGA2B.
+
+    References
+    ----------
+    Deb, K., Rao N., U. B., and Karthik, S. (2007).
+    Dynamic multi-objective optimization and decision-making using modified NSGA-II:
+        A case study on hydro-thermal power scheduling.
+    Evolutionary Multi-Criterion Optimization, 803–817.
+    https://doi.org/10.1007/978-3-540-70928-2_60
+    """
 
     def __init__(self,
-                 perc_detect_change=0.1,
-                 eps=0.0,
-                 perc_diversity=0.3,
+                 perc_detect_change: float = 0.1,
+                 eps: float = 0.0,
+                 perc_diversity: float = 0.3,
                  **kwargs):
         super().__init__(perc_detect_change=perc_detect_change,
                          eps=eps,
@@ -123,7 +186,7 @@ class DNSGA2B(DNSGA2):
 
         self.perc_diversity = perc_diversity
 
-    def _response_mechanism(self):
+    def _response_mechanism(self) -> Population:
         """Response mechanism."""
         pop = self.pop
         X = pop.get("X")

{pydmoo-0.1.2 → pydmoo-0.1.4}/pydmoo/algorithms/base/moo/moeadde.py

@@ -7,13 +7,18 @@ from pydmoo.algorithms.base.moo.moead import MOEAD
 
 
 class MOEADDE(MOEAD):
-    """MOEA/D-DE (Updated by Cao).
-
-    It is worth noting that there is a distinct modification in line 28 compared with the original framework of MOEA/D-DE.
-    The newly generated solution competes with each member from the corresponding mating neighborhood (denoted as Pool in Algorithm 2).
-    But in the original MOEA/D-DE framework, it only competes with two members from the corresponding mating neighborhood.
-    This modification expands the replacement neighborhood to enhance the exploitation capability that is extremely important in dealing with DMOPs.
-
+    """MOEA/D-DE.
+
+    Notes
+    -----
+    It is worth noting that there is a distinct modification in line 28 compared with the original framework of
+    MOEA/D-DE. The newly generated solution competes with each member from the corresponding mating neighborhood
+    (denoted as Pool in Algorithm 2). But in the original MOEA/D-DE framework, it only competes with two members from
+    the corresponding mating neighborhood. This modification expands the replacement neighborhood to enhance the
+    exploitation capability that is extremely important in dealing with DMOPs (Cao et al., 2020).
+
+    References
+    ----------
     Cao, L., Xu, L., Goodman, E. D., Bao, C., and Zhu, S. (2020).
     Evolutionary dynamic multiobjective optimization assisted by a support vector regression predictor.
     IEEE Transactions on Evolutionary Computation, 24(2), 305–319.

pydmoo-0.1.4/pydmoo/algorithms/classic/moead_svr.py

@@ -0,0 +1,86 @@
+import numpy as np
+from pymoo.core.population import Population
+from sklearn.svm import SVR
+
+from pydmoo.algorithms.base.dmoo.dmoead import DMOEAD
+
+
+class MOEADSVR(DMOEAD):
+    """Support Vector Regression (SVR).
+
+    Notes
+    -----
+    [Official Python Code](https://github.com/LeileiCao/MOEA-D-SVR/blob/master/MOEAD-SVR%20.py)
+
+    References
+    ----------
+    Cao, L., Xu, L., Goodman, E. D., Bao, C., and Zhu, S. (2020).
+    Evolutionary dynamic multiobjective optimization assisted by a support vector regression predictor.
+    IEEE Transactions on Evolutionary Computation, 24(2), 305–319.
+    https://doi.org/10.1109/TEVC.2019.2925722
+    """
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+        # SVR
+        self._q = 4  # the number of preceding values that are correlated with the target value (dimension of input samples in the SVR model)
+        self._C = 1000  # the regularization constant in SVR model
+        self._epsilon = 0.05  # the insensitive tube size in SVR model
+        # self._gamma = 1/d  # the Gaussian RBF kernel parameter used in SVR model, and d is the number of variables
+
+    def _response_mechanism(self):
+        """Response mechanism."""
+        pop = self.pop
+        X = pop.get("X")
+
+        old = self.data.get("stacked_X", None)
+        if old is None:
+            stacked_X = np.expand_dims(X, axis=0)
+        else:
+            stacked_X = np.concatenate((old, np.expand_dims(X, axis=0)), axis=0)
+        self.data["stacked_X"] = stacked_X
+
+        N, d = X.shape
+        sol = np.zeros((N, d))
+        K = len(stacked_X)
+
+        if K < self._q + 2:
+            # recreate the current population without being evaluated
+            # Re-evaluate the current population, and update the reference point
+            pop = Population.new(X=X)
+
+            return pop
+
+        # Precompute sliding window indices to avoid redundant calculations
+        window_indices = np.lib.stride_tricks.sliding_window_view(np.arange(K), self._q + 1)
+
+        for i in range(N):
+            for j in range(d):
+                # Extract the time series for this (i,j) position
+                ts = stacked_X[:K, i, j]
+
+                # Create training data using vectorized sliding windows
+                train = ts[window_indices]
+                x_train = train[:, :-1]
+                y_train = train[:, -1]
+
+                # Train SVR model (consider moving this outside loops if possible)
+                # gamma if 'auto', uses 1 / n_features (not provided in code but provided in paper)
+                # versionchanged:: 0.22
+                # The default value of ``gamma`` changed from 'auto' to 'scale'.
+                svr = SVR(kernel='rbf', epsilon=self._epsilon, C=self._C, gamma=1/d)
+                model = svr.fit(x_train, y_train)
+
+                # Make prediction
+                sol[i, j] = model.predict(ts[-self._q:].reshape(1, -1))
+
+        # bounds
+        if self.problem.has_bounds():
+            xl, xu = self.problem.bounds()
+            sol = np.clip(sol, xl, xu)  # provided in the original reference literature
+
+        # recreate the current population without being evaluated
+        pop = Population.new(X=sol)
+
+        return pop

pydmoo-0.1.4/pydmoo/algorithms/classic/moeadde_svr.py

@@ -0,0 +1,86 @@
+import numpy as np
+from pymoo.core.population import Population
+from sklearn.svm import SVR
+
+from pydmoo.algorithms.base.dmoo.dmoeadde import DMOEADDE
+
+
+class MOEADDESVR(DMOEADDE):
+    """Support Vector Regression (SVR).
+
+    Notes
+    -----
+    [Official Python Code](https://github.com/LeileiCao/MOEA-D-SVR/blob/master/MOEAD-SVR%20.py)
+
+    References
+    ----------
+    Cao, L., Xu, L., Goodman, E. D., Bao, C., and Zhu, S. (2020).
+    Evolutionary dynamic multiobjective optimization assisted by a support vector regression predictor.
+    IEEE Transactions on Evolutionary Computation, 24(2), 305–319.
+    https://doi.org/10.1109/TEVC.2019.2925722
+    """
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+        # SVR
+        self._q = 4  # the number of preceding values that are correlated with the target value (dimension of input samples in the SVR model)
+        self._C = 1000  # the regularization constant in SVR model
+        self._epsilon = 0.05  # the insensitive tube size in SVR model
+        # self._gamma = 1/d  # the Gaussian RBF kernel parameter used in SVR model, and d is the number of variables
+
+    def _response_mechanism(self):
+        """Response mechanism."""
+        pop = self.pop
+        X = pop.get("X")
+
+        old = self.data.get("stacked_X", None)
+        if old is None:
+            stacked_X = np.expand_dims(X, axis=0)
+        else:
+            stacked_X = np.concatenate((old, np.expand_dims(X, axis=0)), axis=0)
+        self.data["stacked_X"] = stacked_X
+
+        N, d = X.shape
+        sol = np.zeros((N, d))
+        K = len(stacked_X)
+
+        if K < self._q + 2:
+            # recreate the current population without being evaluated
+            # Re-evaluate the current population, and update the reference point
+            pop = Population.new(X=X)
+
+            return pop
+
+        # Precompute sliding window indices to avoid redundant calculations
+        window_indices = np.lib.stride_tricks.sliding_window_view(np.arange(K), self._q + 1)
+
+        for i in range(N):
+            for j in range(d):
+                # Extract the time series for this (i,j) position
+                ts = stacked_X[:K, i, j]
+
+                # Create training data using vectorized sliding windows
+                train = ts[window_indices]
+                x_train = train[:, :-1]
+                y_train = train[:, -1]
+
+                # Train SVR model (consider moving this outside loops if possible)
+                # gamma if 'auto', uses 1 / n_features (not provided in code but provided in paper)
+                # versionchanged:: 0.22
+                # The default value of ``gamma`` changed from 'auto' to 'scale'.
+                svr = SVR(kernel='rbf', epsilon=self._epsilon, C=self._C, gamma=1/d)
+                model = svr.fit(x_train, y_train)
+
+                # Make prediction
+                sol[i, j] = model.predict(ts[-self._q:].reshape(1, -1))[0]
+
+        # bounds
+        if self.problem.has_bounds():
+            xl, xu = self.problem.bounds()
+            sol = np.clip(sol, xl, xu)  # provided in the original reference literature
+
+        # recreate the current population without being evaluated
+        pop = Population.new(X=sol)
+
+        return pop