add history

Author: ngocbh

.vim/coc-settings.json

@@ -1,5 +1,5 @@
 {
   "python.linting.pylintEnabled": true,
   "python.linting.enabled": true,
-  "python.formatting.provider": "autopep8"
+  // "python.formatting.provider": "autopep8"
 }

examples/knapsack/knapsack.py

@@ -69,7 +69,8 @@ def fitness(indv):
 
 
 # engine.create_seed(seed)
-engine.run()
+history = engine.run()
+print(history.history)
 ans = engine.get_best_indv()
 print(ans)
 # print(engine.population)

examples/zdt1/nsgaii.py

@@ -58,7 +58,8 @@ def eval_h(f: float, g: float) -> float:
     h = eval_h(solution[0], g)
     return h * g
 
-engine.run()
+history = engine.run()
+print(history)
 
 pareto_front = engine.get_pareto_front()
 

geneticpython/callbacks/callback_list.py

@@ -11,37 +11,28 @@
 from typing import List
 
 from .callback import Callback
-from .history import History, SingleObjectiveHistory, MultiObjectiveHistory
+from .history import History
 from .progbar_logger import ProgbarLogger
 
 
 class CallbackList():
-    def __init__(self, callbacks: List[Callback] = None, add_so_history=False, add_mo_history=False, add_progbar=False):
+    def __init__(self, callbacks: List[Callback] = None, add_history=False, add_progbar=False):
         self.callbacks = callbacks if callbacks else []
         self._add_default_callbacks(
-            add_so_history, add_mo_history, add_progbar)
-
-    def _add_default_callbacks(self, add_so_history, add_mo_history, add_progbar):
-        if add_mo_history and add_so_history:
-            raise ValueError("Cannot add both SingleObjectiveHistory and MultiObjectiveHistory\n \
-                             Use one of them")
+            add_history, add_progbar)
 
+    def _add_default_callbacks(self, add_history, add_progbar):
         self._history = None
         self._progbar = None
 
         for cb in self.callbacks:
-            if isinstance(cb, SingleObjectiveHistory) and add_so_history:
-                self._history = cb
-            elif isinstance(cb, MultiObjectiveHistory) and add_mo_history:
+            if isinstance(cb, History) and add_history:
                 self._history = cb
             elif isinstance(cb, ProgbarLogger):
                 self._progbar = cb
 
-        if self._history is None and add_so_history:
-            self._history = SingleObjectiveHistory()
-            self.callbacks.append(self._history)
-        if self._history is None and add_mo_history:
-            self._history = MultiObjectiveHistory()
+        if self._history is None and add_history:
+            self._history = History()
             self.callbacks.append(self._history)
         if self._progbar is None and add_progbar:
             self._progbar = ProgbarLogger()

geneticpython/callbacks/history.py

@@ -14,8 +14,15 @@
 
 
 class History(Callback):
+    """Callback that records events into a `History` object.
+    This callback is automatically applied to
+    every Genetic engine. The `History` object
+    gets returned by the `run` method of engine.
+    """
+
     def __init__(self):
-        pass
+        super(History, self).__init__()
+        self.history = []
 
     def on_init_population_end(self, logs=None):
         pass
@@ -24,12 +31,8 @@ def on_generation_begin(self, gen, logs=None):
         pass
 
     def on_generation_end(self, gen, logs=None):
-        pass
-
-
-class MultiObjectiveHistory(History):
-    pass
-
-
-class SingleObjectiveHistory(History):
-    pass
+        logs = logs or {}
+        self.history.append(logs)
+        # Set the history attribute on the model after the epoch ends. This will
+        # make sure that the state which is set is the latest one.
+        self.engine.history = self

geneticpython/callbacks/progbar_logger.py

@@ -23,20 +23,17 @@ def on_init_population_end(self, logs=None):
         self.progbar = tqdm(range(self.engine.MAX_ITER))
 
     def on_generation_end(self, gen, logs=None):
-        logs = self._update_logs(logs)
-        self.progbar.set_postfix(logs, refresh=True)
+        self._update_metrics()
+        self.progbar.set_postfix(self.metrics, refresh=True)
         self.progbar.update()
 
     def on_running_end(self, logs=None):
         self.progbar.close()
 
-    def _update_logs(self, logs):
-        logs = logs or OrderedDict()
+    def _update_metrics(self):
+        self.metrics = self.metrics or OrderedDict()
         if self.default_metrics and self.engine.metrics:
             if not isinstance(self.engine.metrics, (dict, OrderedDict)):
                 raise TypeError(
                     f'engine.metrics (type : {type(self.engine.metrics).__name__}) has be an instance of Dict or OrderedDict')
-            for name, value in self.engine.metrics.items():
-                logs[name] = value
-
-        return logs
+            self.metrics.update(self.engine.metrics)

geneticpython/engines/gaengine.py

@@ -52,6 +52,7 @@ def __init__(self, population: Population,
         self.callbacks = callbacks
         self.callbacks.set_engine(self)
         self.metrics = None
+        self.history = None
 
     def create_seed(self, seed: int):
         self.rand = random.Random(seed)
@@ -88,43 +89,48 @@ def do_evaluation(self, population: List[Individual]) -> List[Individual]:
     def do_replacement(self, new_population: List[Individual]) -> List[Individual]:
         pass
 
-    def _update_metrics(self):
+    def _update_metrics(self) -> None:
+        pass
+
+    def _update_logs(self, logs) -> None:
         pass
 
     def run(self) -> History:
-        self.callbacks.on_running_begin()
+        logs = None
+        self.callbacks.on_running_begin(logs=logs)
 
-        self.callbacks.on_init_population_begin()
+        self.callbacks.on_init_population_begin(logs=logs)
         self.population.individuals = self.do_initialization()
-        self.callbacks.on_init_population_end()
+        self.callbacks.on_init_population_end(logs=logs)
 
         for gen in range(self.MAX_ITER):
-            self.callbacks.on_generation_begin(gen)
-            self.callbacks.on_selection_begin(gen)
+            self.callbacks.on_generation_begin(gen, logs=logs)
+            self.callbacks.on_selection_begin(gen, logs=logs)
             mating_population = self.do_selection()
-            self.callbacks.on_selection_end(gen)
+            self.callbacks.on_selection_end(gen, logs=logs)
 
-            self.callbacks.on_reproduction_begin(gen)
+            self.callbacks.on_reproduction_begin(gen, logs=logs)
             offspring_population = self.do_reproduction(mating_population)
-            self.callbacks.on_reproduction_end(gen)
+            self.callbacks.on_reproduction_end(gen, logs=logs)
 
-            self.callbacks.on_evaluation_begin(gen)
+            self.callbacks.on_evaluation_begin(gen, logs=logs)
             offspring_population = self.do_evaluation(offspring_population)
-            self.callbacks.on_evaluation_end(gen)
+            self.callbacks.on_evaluation_end(gen, logs=logs)
 
             new_population = self.population.individuals + offspring_population
 
-            self.callbacks.on_replacement_begin(gen)
+            self.callbacks.on_replacement_begin(gen, logs=logs)
             self.population.individuals = self.do_replacement(new_population)
-            self.callbacks.on_replacement_end(gen)
+            self.callbacks.on_replacement_end(gen, logs=logs)
 
             self._update_metrics()
+            logs = self._update_logs(logs)
 
-            self.callbacks.on_generation_end(gen)
+            self.callbacks.on_generation_end(gen, logs=logs)
 
-        self.callbacks.on_running_end()
+        self.callbacks.on_running_end(logs=logs)
 
-        return self.callbacks._history
+        return self.history
 
     def get_all_solutions(self) -> List[Individual]:
         return self.population.individuals

geneticpython/engines/geneticengine.py

@@ -10,10 +10,11 @@
 
 from typing import Union, Callable, List
 from functools import wraps
+from abc import ABC, abstractmethod
 
 from ..geneticengine import GeneticEngine
 from ...callbacks import Callback, CallbackList
-from ...callbacks import History, MultiObjectiveHistory
+from ...callbacks import History
 from ...core.population import Population
 from ...core.operators import Selection, Crossover, Mutation, Replacement
 from ...core.individual import Individual
@@ -33,7 +34,7 @@ def __init__(self, population: Population,
                  max_iter: int = 100,
                  random_state: int = None):
         callback_list = CallbackList(
-            callbacks, add_mo_history=True, add_progbar=True)
+            callbacks, add_history=True, add_progbar=True)
         super(MultiObjectiveEngine, self).__init__(population=population,
                                                    selection=selection,
                                                    selection_size=selection_size,
@@ -44,6 +45,19 @@ def __init__(self, population: Population,
                                                    max_iter=max_iter,
                                                    random_state=random_state)
 
+    @abstractmethod
+    def get_pareto_front(self) -> List[Individual]:
+        pass
+
+    def _update_logs(self, logs):
+        logs = logs or {}
+        pareto_front = [
+            indv.objectives for indv in self.get_pareto_front()]
+        logs.update({'pareto_front': pareto_front})
+        solutions = [indv.objectives for indv in self.get_all_solutions()]
+        logs.update({'solutions': solutions})
+        return logs
+
     def minimize_objective(self, fn):
         """
             register objective function

geneticpython/engines/multi_objective/multi_objective_engine.py

@@ -14,7 +14,7 @@
 from ...core.population import Population
 from ...core.operators import Selection, Crossover, Mutation, Replacement, RankReplacement
 from ..geneticengine import GeneticEngine
-from ...callbacks import CallbackList, Callback, History, MultiObjectiveHistory
+from ...callbacks import CallbackList, Callback, History
 from .multi_objective_engine import MultiObjectiveEngine
 
 import random
@@ -238,7 +238,7 @@ def do_replacement(self, new_population) -> List[Individual]:
             comparator=NSGAIIEngine.crowded_comparator,
             sorted=True,
             rand=self.rand)
-        return new_population
+        return new_population 
 
     def run(self) -> History:
         return super(NSGAIIEngine, self).run()

geneticpython/engines/multi_objective/nsgaiiengine.py

@@ -15,7 +15,7 @@
 from ...core.operators import Selection, Crossover, Mutation, Replacement
 from ..geneticengine import GeneticEngine
 from .single_objective_engine import SingleObjectiveEngine
-from ...callbacks import Callback, History, SingleObjectiveHistory, CallbackList
+from ...callbacks import Callback, History, CallbackList
 
 import random
 import math