learn_2s_som.m 13.9 KB
Newer Older
1
function [sMap sMap_denorm Result] = learn_2s_som(A,nb_neurone,varargin)
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
% Cree la carte SOM ou S2-SOM Pour donnees cachees
%
% En entree obligatoire
%
%   A: les donnees cachees
%   nb_neurone: Nombre de neurones 
%
% En option
%
%   radius: en forme de vecteur, chaque deux elements qui ce suivent constitue
%           une temperature [i..i+1],[i+1..i+2],....
%   trainlen: en forme de vecteur: chaque element constitue une itération de
%           l'entraienement. NB:vecteur radius doit avoir un element en plus
%           que le vecteur trainlen.
%   tracking: pour visualiser l'apprentissage.
%
%   'S2-SOM': pour faire l'apprentissage avec S2-SOM. Si 'S2-SOM' est
%           specifie alors il faut d'autres parametres:
%
%   DimData: vecteur contenant la dimention de chaque bloc.
%   lambda: vecteur, c'est un hyperparametre pour calculer le poids sur les
%           blocs.
%   eta: vecteur, c'est un hyperparametre pour calculer le poids sur les
%           variables.
%
% En sortie
%
%   sMap: La carte SOM ou S2-SOM.
%
%   sMap_denorm: La carte SOM ou S2-SOM, denormalisee.
%
%   Result: structure (vecteur) avec les sorties ou resultats de chaque cas
%           entraine (avec une paire distincte de la combinaison entre lambda
%           et eta): sMap, bmus, Alpha, Beta, Perf.
%
%           Champs de Result:
%              sMap: La carte SOM ou S2-SOM du cas.
%              bmus: Bmus (best matching units) sur toute la zone.
%              Alpha: Coefficients Alpha multipliant les groupes.
%              Beta: Coefficients Alpha multipliant les variables au sans de la
%                  Carte Topologique.
%              Perf: parametre "distortion measure for the map", calcule par
%                  la fonction som_distortion.
%
%   (bmus_pixel:(best matching units) par pixel.)
% Detailed explanation goes here
  
  
50 51 52 53
% Valeurs par defaut
  tracking       = 0;
  init           = 'lininit';
  lattice        = 'rect';
54 55 56
    
  % flags et variables associees
  bool_verbose      = false;
57
  bool_norm         = false; type_norm     = 'simple';
58 59 60 61 62
  bool_rad          = false; rad           = [5 1];
  bool_trainlen     = false; trlen         = 20;
  bool_rad_2s_som   = false; rad_2s_som    = [];
  bool_trlen_2s_som = false; trlen_2s_som  = [];
  bool_2ssom        = false;
63
  bool_DimData      = false; DimData       = [size(A,2)];
64 65
  bool_lambda       = false; lambda        = 1;
  bool_eta          = false; eta           = 1000;
66

67
  Result            = [];
68
  
69
  bool_init_with_make = true;
70
  bool_pre_training   = true;
71 72 73 74 75
  
  %recuperer les donnees
  data.data=A;
  label=[1:size(data.data,2)];
  
76
  %Labelise les donnees (affectation apres boucle d'arguments (selon la valeur de DimBloc)
77 78 79 80
  ListVar={};
  
  data_casename='simulation';
  
81 82 83 84 85
  % --- CM pour ajouter les arguments 'data_name' et 'comp_names'
  i=1;
  while (i<=length(varargin))
    if ischar(varargin{i})
      switch varargin{i},
86
        case { 'verbose', '-verbose' },
87
          bool_verbose = true;
88
        case { 'data_name' },
89
          data_casename = varargin{i+1}; i=i+1;
90
        case { 'comp_names' },
91
          ListVar = varargin{i+1}; i=i+1;
92
        case { 'norm' },
93
          bool_norm = true; 
94 95 96 97 98 99 100 101
          type_norm = varargin{i+1}; i=i+1;
        case { 'init' },
          init = varargin{i+1}; i=i+1;
        case { 'tracking' },
          tracking = varargin{i+1}; i=i+1;
        case { 'lattice' },
          lattice = varargin{i+1}; i=i+1;
        case 'radius'
102
          bool_rad = true;
103 104
          rad = varargin{i+1}; i=i+1;
        case 'trainlen' 
105
          bool_trainlen = true;
106
          trlen = varargin{i+1}; i=i+1;
107 108 109 110 111 112
        case 'radius-2s-som'
          bool_rad_2s_som = true;
          rad_2s_som = varargin{i+1}; i=i+1;
        case 'trainlen-2s-som' 
          bool_trlen_2s_som = true;
          trlen_2s_som = varargin{i+1}; i=i+1;
113 114
        case 'S2-SOM'
          disp('** S2-SOM Active **');
115
          bool_2ssom = true;
116 117 118 119 120
        case 'DimData'
          DimData = varargin{i+1}; i=i+1;
          for di=1:length(DimData)
            DimBloc(di).Dim = DimData(di);
          end
121
          bool_DimData = true;
122 123 124 125 126
        case 'lambda' 
          lambda=varargin{i+1}; i=i+1;
          if length(lambda) < 1
            error('lambda est de longueur nulle !  Il doit y avoir au moins une valeur')
          end
127
          bool_lambda = true;
128 129 130 131 132
        case 'eta' 
          eta = varargin{i+1}; i=i+1;
          if length(eta) < 1
            error('eta est de longueur nulle !  Il doit y avoir au moins une valeur')
          end
133
          bool_eta = true;
134 135 136 137
        case 'ini-with-make'
          bool_init_with_make = true;
        case 'no-ini-with-make'
          bool_init_with_make = false;
138 139 140 141
        case 'pre-training'
          bool_pre_training   = true;
        case 'no-pre-training'
          bool_pre_training   = false;
142 143 144
        otherwise
          error(sprintf(' *** %s error: argument(%d) ''%s'' inconnu ***\n', ...
                        mfilename, i, varargin{i}));
145
      end
146 147 148
    else
      error(sprintf(' *** %s error: argument non-string inattendu (en %d-iemme position) ***\n', ...
                    mfilename, i));
149 150 151
    end
    i=i+1;
  end
152 153 154 155 156 157 158 159 160 161 162 163 164
  
  if isempty(ListVar),
    kVar = 1;
    for iG = 1:length(DimData),
      szG = DimData(iG);
      for l = 1:szG
        ListVar{kVar,1} = sprintf('Gr%dVar%d', iG, l);
        kVar = kVar + 1;
      end
    end
  end

  data.colheaders = ListVar;
165

166
  sD = som_data_struct(data.data,'name', data_casename,'comp_names', upper(ListVar));
167 168 169 170 171 172 173 174
  % i=1;
  % while (i<=length(varargin) && bool_norm==0)
  %   if strcmp(varargin{i},'norm')
  %     bool_norm=1; 
  %     type_norm=varargin{i+1};
  %   end
  %   i=i+1;
  % end
175 176 177 178 179 180 181 182 183
  
  %normalisation des donnees
  if bool_norm
    fprintf(1,'\n-- Normalisation des donnees selon ''%s'' ...\n', type_norm);
    if strcmp(type_norm,'simple')
      sD_norm=som_normalize(sD);
    else
      sD_norm=som_normalize(sD,type_norm);
    end
184
  else
185
    fprintf(1,'\n** Pas de normalisation des donnees **\n');
186 187 188 189
    sD_norm = sD;
  end
  
  
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
  % if ~isempty(varargin)
  %   i=1;
  %   while i<=length(varargin)
  %     if strcmp(varargin{i},'init')
  %       init=varargin{i+1};
  %     end
  %     if strcmp(varargin{i},'tracking')
  %       tracking=varargin{i+1};
  %     end
  %     if strcmp(varargin{i},'lattice')
  %       lattice=varargin{i+1};
  %     end
  %     i=i+1;
  %   end
  % end
205

206 207 208 209 210 211
  fprintf(1,[ '\n-- ------------------------------------------------------------------\n', ...
              '-- New 2S-SOMTraining function:\n', ...
              '--   %s (''%s'', ''%s'', ''%s'', ... )\n', ...
              '-- ------------------------------------------------------------------\n' ], ...
          mfilename, init, lattice, data_casename);

212
  %SOM initialisation
213
  if bool_init_with_make
214
    fprintf(1,'\n-- Initialisation avec SOM_MAKE ... ')
215
    sMap=som_make(sD_norm, ...
216 217 218 219 220 221 222 223
                  'munits',   nb_neurone, ...
                  'lattice',  lattice, ...
                  'init',     init, ...
                  'tracking', tracking); % creer la carte initiale avec et effectuer un entrainenemt

  else
    if strcmp(init,'randinit')
      fprintf(1,'\n-- Initialisation avec SOM_RANDINIT ... ')
224
      sMap=som_randinit(sD_norm, ...
225 226 227 228 229 230
                        'munits',   nb_neurone, ...
                        'lattice',  lattice, ...
                        'tracking', tracking); % creer la carte initiale

    elseif strcmp(init,'lininit')
      fprintf(1,'\n-- Initialisation avec SOM_LININIT ... ')
231
      sMap=som_lininit(sD_norm, ...
232 233 234 235 236 237 238 239 240 241 242 243
                       'munits',   nb_neurone, ...
                       'lattice',  lattice, ...
                       'tracking', tracking); % creer la carte initiale

    else
      error(sprintf(['\n *** %s error: invalid ''init'' option ''%s'' ***\n', ...
                     '     Shoud be one between { ''lininit'', ''randinit'' } ***\n' ], ...
                    mfilename, init));
    end
    fprintf(1,' <som init END>.\n')
  end
  
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
  % bool_rad=0;
  % bool_trainlen=0;
  % if ~isempty(varargin)
  % 
  %   i=1;
  %   while i<=length(varargin)
  %     if ischar(varargin{i})
  %       switch varargin{i}
  %         case 'radius'
  %           bool_rad=1;
  %           loc_rad=i;
  %           rad=varargin{loc_rad+1};
  %           i=i+1;
  %         case 'trainlen' 
  %           bool_trainlen=1;
  %           loc_trainlen=i;
  %           trlen=varargin{loc_trainlen+1};
  %           i=i+1;
  %         otherwise
  %           i=i+1;
  %       end
  %     else
  %       i=i+1;
  %     end
  %   end

270
  if bool_pre_training
271 272
    pretrain_tracking = tracking;
    %pretrain_tracking = 1;
273
    
274 275 276
    % batchtrain avec radius ...
    if (bool_rad && ~bool_trainlen)
      fprintf(1,'\n-- BATCHTRAIN initial avec radius ... ')
277
      if pretrain_tracking, fprintf(1,'\n'); end
278 279 280
      j=1;
      while j<length(rad)
        
281
        sMap=som_batchtrain(sMap, sD_norm, ...
282 283
                            'radius',[rad(j) rad(j+1)], ...
                            'tracking',pretrain_tracking);
284 285
        j=j+1;
        
286 287
      end
    end
288 289 290
    % batchtrain avec trainlen ...
    if (~bool_rad && bool_trainlen) 
      fprintf(1,'\n-- BATCHTRAIN initial avec trainlen ... ')
291
      if pretrain_tracking, fprintf(1,'\n'); end
292 293 294
      j=1;
      while j<=length(trlen)
        
295
        sMap=som_batchtrain(sMap, sD_norm, ...
296 297
                            'trainlen',trlen(j), ...
                            'tracking',pretrain_tracking);
298 299 300 301 302
        j=j+1;
        
      end
    end
    % batchtrain avec radius et trainlen             
303
    if (bool_rad && bool_trainlen)
304
      fprintf(1,'\n-- BATCHTRAIN initial avec radius et trainlen ... \n')
305
      if pretrain_tracking, fprintf(1,'\n'); end
306 307
      if length(rad)==length(trlen)+1
        
308 309 310
        j=1;
        while j<length(rad)
          
311
          sMap=som_batchtrain(sMap, sD_norm, ...
312 313 314
                              'radius',[rad(j) rad(j+1)], ...
                              'trainlen',trlen(j), ...
                              'tracking',pretrain_tracking);
315 316 317
          j=j+1;
          
        end
318 319
      else
        error('vecteur radius doit avoir un element en plus que le vecteur trainlen ')
320
      end
321 322 323 324 325 326
    end
    
    current_perf = som_distortion(sMap,sD_norm);
    fprintf(1,'--> som_distortion apres entrainement initiale = %s\n', num2str(current_perf));
    
  else
327
    fprintf(1,'** batchtrain initial (pre-training) non active **\n')
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
  end
  % end
  
  % %S2-SOM
  % bool_2ssom=0;
  % bool_DimData=0;
  % bool_lambda=0;
  % bool_eta=0;
  %
  % if ~isempty(varargin)
  %   i=1;
  %   while i<=length(varargin)
  %     if ischar(varargin{i}) 
  %       switch varargin{i} 
  %      
  %         case 'S2-SOM'
  %           disp('** S2-SOM Active **');
  %           bool_2ssom=1;
  %           i=i+1;
  %           %mettre en bloc
  %         case 'DimData'
  %           i=i+1;
  %           DimData=varargin{i};
  %           for di=1:length(DimData)
  %             DimBloc(di).Dim=DimData(di);
  %           end
  %           bool_DimData=1;
  %         case 'lambda' 
  %           i=i+1; 
  %           lambda=varargin{i};
  %           if length(lambda) < 1
  %             error('lambda est de longueur nulle !  Il doit y avoir au moins une valeur')
  %           end
  %           bool_lambda=1;
  %         case 'eta' 
  %           i=i+1; eta=varargin{i};
  %           if length(eta) < 1
  %             error('eta est de longueur nulle !  Il doit y avoir au moins une valeur')
  %           end
  %           bool_eta=1;
  %         otherwise
  %           i=i+1;
  %
  %       end
  %     else
  %       i=i+1;
  %     end
  %   end
  
  if (bool_2ssom)
378
    if (bool_lambda && bool_eta && bool_DimData)
379 380 381 382 383 384 385
      
      best_i   = 0;
      best_j   = 0;
      bestperf = inf;
      
      i_train = 1;
      n_train = length(lambda)*length(eta);
386
      
387 388 389 390 391 392 393
      if ~bool_rad_2s_som
        rad_2s_som =  [rad(round(length(rad)/2)) ...
                          rad((round(length(rad)/2))+1)];
      end
      if ~bool_trlen_2s_som
        trlen_2s_som = trlen(round(length(trlen)/2));
      end
394

395 396 397
      fprintf(1,[ '\n-- batchtrainRTOM loop for %d lambda and %d eta values:\n', ... 
                  '-- ------------------------------------------------------------------\n' ], ...
              length(lambda), length(eta));
398
      if tracking > 1,
399 400
        fprintf(1,'   ... trainlen_2s_som ... %s\n', num2str(trlen_2s_som))
        fprintf(1,'   ... radius_2s_som ..... [%s]\n', join(string(rad_2s_som),', '))
401
      end
402 403
      for i=1:length(lambda)
        for j=1:length(eta)
404
          fprintf(1,'-- batchtrainRTOM (%d/%d) with lambda=%s and eta=%s ... ',i_train, ...
405 406
                  n_train, num2str(lambda(i)),num2str(eta(j)));
          if tracking, fprintf(1,'\n'); end
407
          
408 409 410 411 412 413 414
          [Result(i,j).sMap Result(i,j).bmus Result(i,j).Alpha Result(i,j).Beta] = som_batchtrainRTOM( ...
              sMap, sD_norm, ...
              'TypeAlgo','2SSOM', ...
              'DimData',DimData, ...
              'DimBloc',DimBloc, ...
              'lambda', lambda(i), ...
              'eta',eta(j), ...
415 416
              'radius',rad_2s_som, ...
              'trainlen',trlen_2s_som, ...
417
              'tracking',tracking);
418
          
419 420 421 422 423 424 425 426 427 428 429 430 431 432
          current_perf = som_distortion(Result(i,j).sMap,sD_norm);
          fprintf(1,'   --> som_distortion=%s\n', num2str(current_perf));
          %  end
          %end
          % best_i=0;
          % best_j=0;
          % bestperf=inf;
          % for i=1:length(lambda)
          %   for j=1:length(eta)
          %         
          Result(i,j).Perf = current_perf;
          if Result(i,j).Perf < bestperf
            best_i = i;
            best_j = j;
433
          end
434 435
          
          i_train = i_train + 1;
436 437 438
        end
      end
      
439
      sMap = Result(best_i,best_j).sMap;
440 441
      
    else
442
      error('manque de parametre')
443
    end
444 445
  elseif (bool_lambda || bool_eta || bool_DimData)
    error('mentionnez si vous voulez S2-SOM')
446 447
  end
  
448
  % end
449 450 451 452 453 454 455 456 457
  
  % denormalisation de la Map
  if bool_norm
    sMap_denorm=som_denormalize(sMap,sD_norm.comp_norm);
  else
    sMap_denorm=sMap;
  end
  
  return