learn_2s_som.m 12.6 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 57 58 59 60 61 62
  bool_verbose   = false;
  bool_norm      = false;
  bool_rad       = false;
  bool_trainlen  = false;
  bool_2ssom     = false;
  bool_DimData   = false;
  bool_lambda    = false;
  bool_eta       = false;
63 64

  Result         = [];
65
  
66
  bool_init_with_make = true;
67
  bool_pre_training   = true;
68 69 70 71 72 73 74 75 76 77 78 79 80 81
  
  %recuperer les donnees
  data.data=A;
  label=[1:size(data.data,2)];
  
  %Labelise les donnees
  ListVar={};
  for l=1:length(label)
    ListVar{l}=char(strcat('v ',int2str(label(l))));
  end
  data.colheaders=ListVar;
  
  data_casename='simulation';
  
82 83 84 85 86
  % --- CM pour ajouter les arguments 'data_name' et 'comp_names'
  i=1;
  while (i<=length(varargin))
    if ischar(varargin{i})
      switch varargin{i},
87
        case { 'verbose', '-verbose' },
88
          bool_verbose = true;
89
        case { 'data_name' },
90
          data_casename = varargin{i+1}; i=i+1;
91
        case { 'comp_names' },
92 93
          data.colheaders = varargin{i+1}; i=i+1;
        case { 'norm' },
94
          bool_norm = true; 
95 96 97 98 99 100 101 102
          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'
103
          bool_rad = true;
104 105
          rad = varargin{i+1}; i=i+1;
        case 'trainlen' 
106
          bool_trainlen = true;
107 108 109
          trlen = varargin{i+1}; i=i+1;
        case 'S2-SOM'
          disp('** S2-SOM Active **');
110
          bool_2ssom = true;
111 112 113 114 115
        case 'DimData'
          DimData = varargin{i+1}; i=i+1;
          for di=1:length(DimData)
            DimBloc(di).Dim = DimData(di);
          end
116
          bool_DimData = true;
117 118 119 120 121
        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
122
          bool_lambda = true;
123 124 125 126 127
        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
128
          bool_eta = true;
129 130 131 132
        case 'ini-with-make'
          bool_init_with_make = true;
        case 'no-ini-with-make'
          bool_init_with_make = false;
133 134 135 136
        case 'pre-training'
          bool_pre_training   = true;
        case 'no-pre-training'
          bool_pre_training   = false;
137 138 139
        otherwise
          error(sprintf(' *** %s error: argument(%d) ''%s'' inconnu ***\n', ...
                        mfilename, i, varargin{i}));
140
      end
141 142 143
    else
      error(sprintf(' *** %s error: argument non-string inattendu (en %d-iemme position) ***\n', ...
                    mfilename, i));
144 145 146
    end
    i=i+1;
  end
147

148
  sD = som_data_struct(data.data,'name', data_casename,'comp_names', upper(ListVar));
149 150 151 152 153 154 155 156
  % 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
157 158 159 160 161 162 163 164 165 166
  
  %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
  else           
167
    fprintf(1,'\n** Pas de normalisation des donnees **\n');
168 169 170 171
    sD_norm = sD;
  end
  
  
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
  % 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
187

188 189 190 191 192 193
  fprintf(1,[ '\n-- ------------------------------------------------------------------\n', ...
              '-- New 2S-SOMTraining function:\n', ...
              '--   %s (''%s'', ''%s'', ''%s'', ... )\n', ...
              '-- ------------------------------------------------------------------\n' ], ...
          mfilename, init, lattice, data_casename);

194
  %SOM initialisation
195
  if bool_init_with_make
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
    fprintf(1,'\n-- Initialisation avec SOM_MAKE ... ')
    sMap=som_make(sD_norm.data, ...
                  '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 ... ')
      sMap=som_randinit(sD_norm.data, ...
                        'munits',   nb_neurone, ...
                        'lattice',  lattice, ...
                        'tracking', tracking); % creer la carte initiale

    elseif strcmp(init,'lininit')
      fprintf(1,'\n-- Initialisation avec SOM_LININIT ... ')
      sMap=som_lininit(sD_norm.data, ...
                       '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
  
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
  % 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

252
  if bool_pre_training
253 254
    tracking_ini = tracking;
    %tracking_ini = 1;
255
    
256 257 258 259 260 261 262 263 264 265
    % batchtrain avec radius ...
    if (bool_rad && ~bool_trainlen)
      fprintf(1,'\n-- BATCHTRAIN initial avec radius ... ')
      if tracking_ini, fprintf(1,'\n'); end
      j=1;
      while j<length(rad)
        
        sMap=som_batchtrain(sMap,sD_norm.data,'radius',[rad(j) rad(j+1)],'tracking',tracking_ini);
        j=j+1;
        
266 267
      end
    end
268 269 270 271 272 273 274 275 276 277 278 279 280
    % batchtrain avec trainlen ...
    if (~bool_rad && bool_trainlen) 
      fprintf(1,'\n-- BATCHTRAIN initial avec trainlen ... ')
      if tracking_ini, fprintf(1,'\n'); end
      j=1;
      while j<=length(trlen)
        
        sMap=som_batchtrain(sMap,sD_norm.data,'trainlen',trlen(j),'tracking',tracking_ini);
        j=j+1;
        
      end
    end
    % batchtrain avec radius et trainlen             
281
    if (bool_rad && bool_trainlen)
282 283 284 285
      fprintf(1,'\n-- BATCHTRAIN initial avec radius et trainlen ... \n')
      if tracking_ini, fprintf(1,'\n'); end
      if length(rad)==length(trlen)+1
        
286 287 288
        j=1;
        while j<length(rad)
          
289
          sMap=som_batchtrain(sMap,sD_norm.data,'radius',[rad(j) rad(j+1)],'trainlen',trlen(j),'tracking',tracking_ini);
290 291 292
          j=j+1;
          
        end
293 294
      else
        error('vecteur radius doit avoir un element en plus que le vecteur trainlen ')
295
      end
296 297 298 299 300 301
    end
    
    current_perf = som_distortion(sMap,sD_norm);
    fprintf(1,'--> som_distortion apres entrainement initiale = %s\n', num2str(current_perf));
    
  else
302
    fprintf(1,'** batchtrain initial (pre-training) non active **\n')
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 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
  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)
353
    if (bool_lambda && bool_eta && bool_DimData)
354 355 356 357 358 359 360
      
      best_i   = 0;
      best_j   = 0;
      bestperf = inf;
      
      i_train = 1;
      n_train = length(lambda)*length(eta);
361 362 363
      fprintf(1,[ '\n-- batchtrainRTOM loop for %d lambda and %d eta values:\n', ... 
                  '-- ------------------------------------------------------------------\n' ], ...
              length(lambda), length(eta));
364 365
      for i=1:length(lambda)
        for j=1:length(eta)
366
          fprintf(1,'-- batchtrainRTOM (%d/%d) with lambda=%s and eta=%s ... ',i_train, ...
367 368
                  n_train, num2str(lambda(i)),num2str(eta(j)));
          if tracking, fprintf(1,'\n'); end
369
          
370 371 372 373 374 375 376 377 378 379 380
          [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), ...
              'radius',[rad(round(length(rad)/2)) ...
                        rad((round(length(rad)/2))+1)], ...
              'trainlen',trlen(round(length(trlen)/2)), ...
              'tracking',tracking);
381
          
382 383 384 385 386 387 388 389 390 391 392 393 394 395
          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;
396
          end
397 398
          
          i_train = i_train + 1;
399 400 401
        end
      end
      
402
      sMap = Result(best_i,best_j).sMap;
403 404
      
    else
405
      error('manque de parametre')
406
    end
407 408
  elseif (bool_lambda || bool_eta || bool_DimData)
    error('mentionnez si vous voulez S2-SOM')
409 410
  end
  
411
  % end
412 413 414 415 416 417 418 419 420
  
  % denormalisation de la Map
  if bool_norm
    sMap_denorm=som_denormalize(sMap,sD_norm.comp_norm);
  else
    sMap_denorm=sMap;
  end
  
  return