src/daComposant/daAlgorithms/ParticleSwarmOptimization.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2020 EDF R&D
   4 #
   5 # This library is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU Lesser General Public
   7 # License as published by the Free Software Foundation; either
   8 # version 2.1 of the License.
   9 #
  10 # This library is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # Lesser General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with this library; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18 #
  19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 #
  21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  22
  23 import logging
  24 from daCore import BasicObjects
  25 import numpy, copy
  26
  27 # ==============================================================================
  28 class ElementaryAlgorithm(BasicObjects.Algorithm):
  29     def __init__(self):
  30         BasicObjects.Algorithm.__init__(self, "PARTICLESWARMOPTIMIZATION")
  31         self.defineRequiredParameter(
  32             name     = "MaximumNumberOfSteps",
  33             default  = 50,
  34             typecast = int,
  35             message  = "Nombre maximal de pas d'optimisation",
  36             minval   = 0,
  37             )
  38         self.defineRequiredParameter(
  39             name     = "MaximumNumberOfFunctionEvaluations",
  40             default  = 15000,
  41             typecast = int,
  42             message  = "Nombre maximal d'évaluations de la fonction",
  43             minval   = -1,
  44             )
  45         self.defineRequiredParameter(
  46             name     = "SetSeed",
  47             typecast = numpy.random.seed,
  48             message  = "Graine fixée pour le générateur aléatoire",
  49             )
  50         self.defineRequiredParameter(
  51             name     = "NumberOfInsects",
  52             default  = 100,
  53             typecast = int,
  54             message  = "Nombre d'insectes dans l'essaim",
  55             minval   = -1,
  56             )
  57         self.defineRequiredParameter(
  58             name     = "SwarmVelocity",
  59             default  = 1.,
  60             typecast = float,
  61             message  = "Vitesse de groupe imposée par l'essaim",
  62             minval   = 0.,
  63             )
  64         self.defineRequiredParameter(
  65             name     = "GroupRecallRate",
  66             default  = 0.5,
  67             typecast = float,
  68             message  = "Taux de rappel au meilleur insecte du groupe (entre 0 et 1)",
  69             minval   = 0.,
  70             maxval   = 1.,
  71             )
  72         self.defineRequiredParameter(
  73             name     = "QualityCriterion",
  74             default  = "AugmentedWeightedLeastSquares",
  75             typecast = str,
  76             message  = "Critère de qualité utilisé",
  77             listval  = ["AugmentedWeightedLeastSquares","AWLS","AugmentedPonderatedLeastSquares","APLS","DA",
  78                         "WeightedLeastSquares","WLS","PonderatedLeastSquares","PLS",
  79                         "LeastSquares","LS","L2",
  80                         "AbsoluteValue","L1",
  81                         "MaximumError","ME"],
  82             )
  83         self.defineRequiredParameter(
  84             name     = "StoreInternalVariables",
  85             default  = False,
  86             typecast = bool,
  87             message  = "Stockage des variables internes ou intermédiaires du calcul",
  88             )
  89         self.defineRequiredParameter(
  90             name     = "StoreSupplementaryCalculations",
  91             default  = [],
  92             typecast = tuple,
  93             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
  94             listval  = [
  95                 "Analysis",
  96                 "BMA",
  97                 "CostFunctionJ",
  98                 "CostFunctionJb",
  99                 "CostFunctionJo",
 100                 "CurrentIterationNumber",
 101                 "CurrentState",
 102                 "Innovation",
 103                 "OMA",
 104                 "OMB",
 105                 "SimulatedObservationAtBackground",
 106                 "SimulatedObservationAtCurrentState",
 107                 "SimulatedObservationAtOptimum",
 108                 ]
 109             )
 110         self.defineRequiredParameter( # Pas de type
 111             name     = "BoxBounds",
 112             message  = "Liste des valeurs de bornes d'incréments de paramètres",
 113             )
 114         self.requireInputArguments(
 115             mandatory= ("Xb", "Y", "HO", "R", "B"),
 116             )
 117         self.setAttributes(tags=(
 118             "Optimization",
 119             "NonLinear",
 120             "Population",
 121             ))
 122
 123     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
 124         self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q)
 125         #
 126         if ("BoxBounds" in self._parameters) and isinstance(self._parameters["BoxBounds"], (list, tuple)) and (len(self._parameters["BoxBounds"]) > 0):
 127             BoxBounds = self._parameters["BoxBounds"]
 128             logging.debug("%s Prise en compte des bornes d'incréments de paramètres effectuée"%(self._name,))
 129         else:
 130             raise ValueError("Particle Swarm Optimization requires bounds on all variables increments to be truly given (BoxBounds).")
 131         BoxBounds   = numpy.array(BoxBounds)
 132         if numpy.isnan(BoxBounds).any():
 133             raise ValueError("Particle Swarm Optimization requires bounds on all variables increments to be truly given (BoxBounds), \"None\" is not allowed. The actual increments bounds are:\n%s"%BoxBounds)
 134         #
 135         Phig = float( self._parameters["GroupRecallRate"] )
 136         Phip = 1. - Phig
 137         logging.debug("%s Taux de rappel au meilleur insecte du groupe (entre 0 et 1) = %s et à la meilleure position précédente (son complémentaire à 1) = %s"%(self._name, str(Phig), str(Phip)))
 138         #
 139         # Opérateur d'observation
 140         # -----------------------
 141         Hm = HO["Direct"].appliedTo
 142         #
 143         # Précalcul des inversions de B et R
 144         # ----------------------------------
 145         BI = B.getI()
 146         RI = R.getI()
 147         #
 148         # Définition de la fonction-coût
 149         # ------------------------------
 150         def CostFunction(x, QualityMeasure="AugmentedWeightedLeastSquares"):
 151             _X  = numpy.asmatrix(numpy.ravel( x )).T
 152             _HX = Hm( _X )
 153             _HX = numpy.asmatrix(numpy.ravel( _HX )).T
 154             #
 155             if QualityMeasure in ["AugmentedWeightedLeastSquares","AWLS","AugmentedPonderatedLeastSquares","APLS","DA"]:
 156                 if BI is None or RI is None:
 157                     raise ValueError("Background and Observation error covariance matrix has to be properly defined!")
 158                 Jb  = 0.5 * (_X - Xb).T * BI * (_X - Xb)
 159                 Jo  = 0.5 * (Y - _HX).T * RI * (Y - _HX)
 160             elif QualityMeasure in ["WeightedLeastSquares","WLS","PonderatedLeastSquares","PLS"]:
 161                 if RI is None:
 162                     raise ValueError("Observation error covariance matrix has to be properly defined!")
 163                 Jb  = 0.
 164                 Jo  = 0.5 * (Y - _HX).T * RI * (Y - _HX)
 165             elif QualityMeasure in ["LeastSquares","LS","L2"]:
 166                 Jb  = 0.
 167                 Jo  = 0.5 * (Y - _HX).T * (Y - _HX)
 168             elif QualityMeasure in ["AbsoluteValue","L1"]:
 169                 Jb  = 0.
 170                 Jo  = numpy.sum( numpy.abs(Y - _HX) )
 171             elif QualityMeasure in ["MaximumError","ME"]:
 172                 Jb  = 0.
 173                 Jo  = numpy.max( numpy.abs(Y - _HX) )
 174             #
 175             J   = float( Jb ) + float( Jo )
 176             #
 177             return J
 178         #
 179         # Point de démarrage de l'optimisation : Xini = Xb
 180         # ------------------------------------
 181         if isinstance(Xb, type(numpy.matrix([]))):
 182             Xini = Xb.A1.tolist()
 183         elif Xb is not None:
 184             Xini = list(Xb)
 185         else:
 186             Xini = numpy.zeros(len(BoxBounds[:,0]))
 187         #
 188         # Initialisation des bornes
 189         # -------------------------
 190         SpaceUp  = BoxBounds[:,1] + Xini
 191         SpaceLow = BoxBounds[:,0] + Xini
 192         nbparam  = len(SpaceUp)
 193         #
 194         # Initialisation de l'essaim
 195         # --------------------------
 196         NumberOfFunctionEvaluations = 0
 197         LimitVelocity = numpy.abs(SpaceUp-SpaceLow)
 198         #
 199         PosInsect = []
 200         VelocityInsect = []
 201         for i in range(nbparam) :
 202             PosInsect.append(numpy.random.uniform(low=SpaceLow[i], high=SpaceUp[i], size=self._parameters["NumberOfInsects"]))
 203             VelocityInsect.append(numpy.random.uniform(low=-LimitVelocity[i], high=LimitVelocity[i], size=self._parameters["NumberOfInsects"]))
 204         VelocityInsect = numpy.matrix(VelocityInsect)
 205         PosInsect = numpy.matrix(PosInsect)
 206         #
 207         BestPosInsect = numpy.array(PosInsect)
 208         qBestPosInsect = []
 209         Best = copy.copy(SpaceLow)
 210         qBest = CostFunction(Best,self._parameters["QualityCriterion"])
 211         NumberOfFunctionEvaluations += 1
 212         #
 213         for i in range(self._parameters["NumberOfInsects"]):
 214             insect  = numpy.ravel(PosInsect[:,i])
 215             quality = CostFunction(insect,self._parameters["QualityCriterion"])
 216             NumberOfFunctionEvaluations += 1
 217             qBestPosInsect.append(quality)
 218             if quality < qBest:
 219                 Best  = copy.copy( insect )
 220                 qBest = copy.copy( quality )
 221         logging.debug("%s Initialisation, Insecte = %s, Qualité = %s"%(self._name, str(Best), str(qBest)))
 222         #
 223         self.StoredVariables["CurrentIterationNumber"].store( len(self.StoredVariables["CostFunctionJ"]) )
 224         if self._parameters["StoreInternalVariables"] or self._toStore("CurrentState"):
 225             self.StoredVariables["CurrentState"].store( Best )
 226         self.StoredVariables["CostFunctionJb"].store( 0. )
 227         self.StoredVariables["CostFunctionJo"].store( 0. )
 228         self.StoredVariables["CostFunctionJ" ].store( qBest )
 229         #
 230         # Minimisation de la fonctionnelle
 231         # --------------------------------
 232         for n in range(self._parameters["MaximumNumberOfSteps"]):
 233             for i in range(self._parameters["NumberOfInsects"]) :
 234                 insect  = numpy.ravel(PosInsect[:,i])
 235                 rp = numpy.random.uniform(size=nbparam)
 236                 rg = numpy.random.uniform(size=nbparam)
 237                 for j in range(nbparam) :
 238                     VelocityInsect[j,i] = self._parameters["SwarmVelocity"]*VelocityInsect[j,i] +  Phip*rp[j]*(BestPosInsect[j,i]-PosInsect[j,i]) +  Phig*rg[j]*(Best[j]-PosInsect[j,i])
 239                     PosInsect[j,i] = PosInsect[j,i]+VelocityInsect[j,i]
 240                 quality = CostFunction(insect,self._parameters["QualityCriterion"])
 241                 NumberOfFunctionEvaluations += 1
 242                 if quality < qBestPosInsect[i]:
 243                     BestPosInsect[:,i] = copy.copy( insect )
 244                     qBestPosInsect[i]  = copy.copy( quality )
 245                     if quality < qBest :
 246                         Best  = copy.copy( insect )
 247                         qBest = copy.copy( quality )
 248             logging.debug("%s Etape %i, Insecte = %s, Qualité = %s"%(self._name, n, str(Best), str(qBest)))
 249             #
 250             self.StoredVariables["CurrentIterationNumber"].store( len(self.StoredVariables["CostFunctionJ"]) )
 251             if self._parameters["StoreInternalVariables"] or self._toStore("CurrentState"):
 252                 self.StoredVariables["CurrentState"].store( Best )
 253             if self._toStore("SimulatedObservationAtCurrentState"):
 254                 _HmX = Hm( numpy.asmatrix(numpy.ravel( Best )).T )
 255                 _HmX = numpy.asmatrix(numpy.ravel( _HmX )).T
 256                 self.StoredVariables["SimulatedObservationAtCurrentState"].store( _HmX )
 257             self.StoredVariables["CostFunctionJb"].store( 0. )
 258             self.StoredVariables["CostFunctionJo"].store( 0. )
 259             self.StoredVariables["CostFunctionJ" ].store( qBest )
 260             if NumberOfFunctionEvaluations > self._parameters["MaximumNumberOfFunctionEvaluations"]:
 261                 logging.debug("%s Stopping search because the number %i of function evaluations is exceeding the maximum %i."%(self._name, NumberOfFunctionEvaluations, self._parameters["MaximumNumberOfFunctionEvaluations"]))
 262                 break
 263         #
 264         # Obtention de l'analyse
 265         # ----------------------
 266         Xa = numpy.asmatrix(numpy.ravel( Best )).T
 267         #
 268         self.StoredVariables["Analysis"].store( Xa.A1 )
 269         #
 270         if self._toStore("Innovation") or \
 271             self._toStore("OMB") or \
 272             self._toStore("SimulatedObservationAtBackground"):
 273             HXb = Hm(Xb)
 274             d = Y - HXb
 275         if self._toStore("OMA") or \
 276             self._toStore("SimulatedObservationAtOptimum"):
 277             HXa = Hm(Xa)
 278         #
 279         # Calculs et/ou stockages supplémentaires
 280         # ---------------------------------------
 281         if self._toStore("Innovation"):
 282             self.StoredVariables["Innovation"].store( numpy.ravel(d) )
 283         if self._toStore("BMA"):
 284             self.StoredVariables["BMA"].store( numpy.ravel(Xb) - numpy.ravel(Xa) )
 285         if self._toStore("OMA"):
 286             self.StoredVariables["OMA"].store( numpy.ravel(Y) - numpy.ravel(HXa) )
 287         if self._toStore("OMB"):
 288             self.StoredVariables["OMB"].store( numpy.ravel(d) )
 289         if self._toStore("SimulatedObservationAtBackground"):
 290             self.StoredVariables["SimulatedObservationAtBackground"].store( numpy.ravel(HXb) )
 291         if self._toStore("SimulatedObservationAtOptimum"):
 292             self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel(HXa) )
 293         #
 294         self._post_run(HO)
 295         return 0
 296
 297 # ==============================================================================
 298 if __name__ == "__main__":
 299     print('\n AUTODIAGNOSTIC\n')