learn_2s_som.m 18.3 KB
Newer Older
1
function [StsMap sMap_denorm Resultout sMapPTout] = learn_2s_som(A,nb_neurone,varargin)
2 3
% Cree la carte SOM ou S2-SOM Pour donnees cachees
%
4 5 6 7 8 9
% Usage:
%
%    [sMap, sMap_denorm, Result, sMapPT] = learn_2s_som(A, nb_neurone, <OPTIOS>)
%
%    St = learn_2s_som(A,nb_neurone, '-struct', <OPTIOS>)
%
10 11 12
% En entree obligatoire
%
%   A: les donnees cachees
13
%   nb_neurone: Nombre de neurones
14
%
15 16 17
% En option, elles sont specifies par couples de valeurs, p. exemple:
%
%         'radius', [ 5 1 ], 'trainlen', 20, 'tracking', 1, ...
18
%
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
%
%   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
%
38
%   sMap: La carte SOM ou S2-SOM au point de meilleur "Perf".
39 40 41
%
%   sMap_denorm: La carte SOM ou S2-SOM, denormalisee.
%
42 43
%   iBest = indice dans Result de la carte sMap retournee.
%
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
%   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
59 60


61
% Valeurs par defaut
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
tracking       = 0;
init           = 'lininit';
lattice        = 'rect';

% flags et variables associees
bool_verbose        = false;
bool_return_struct  = false;
bool_norm           = false; type_norm     = 'simple';
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;
bool_DimData        = false; DimData       = [size(A,2)];
bool_lambda         = false; lambda        = 1;
bool_eta            = false; eta           = 1000;
bool_parcomp        = false; parcomp_workers = 8; % 8 workers for parallel computing by default, if activated (if bool_parcomp is true)

Result              = struct([]);

bool_init_with_make = true;
bool_pre_training   = true;

%recuperer les donnees
data.data=A;
label=[1:size(data.data,2)];
88

89 90 91 92 93 94 95 96
%Labelise les donnees (affectation apres boucle d'arguments (selon la valeur de DimBloc)
ListVar={};

data_casename='simulation';

% --- CM pour ajouter les arguments 'data_name' et 'comp_names'
i=1;
while (i<=length(varargin))
97
    if ischar(varargin{i})
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
        switch lower(varargin{i}),
            case { 'verbose', '-verbose' },
                bool_verbose = true;
            case { 'returnstruct', 'return-struct', 'struct', '-return-struct', '-struct' },
                bool_return_struct = true;
            case { 'data_name' },
                data_casename = varargin{i+1}; i=i+1;
            case { 'comp_names' },
                ListVar = varargin{i+1}; i=i+1;
            case { 'norm' },
                bool_norm = true;
                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'
                bool_rad = true;
                rad = varargin{i+1}; i=i+1;
            case 'trainlen'
                bool_trainlen = true;
                trlen = varargin{i+1}; i=i+1;
            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;
            case {'s2-som', '2s-som'},
                disp('** S2-SOM Active **');
                bool_2ssom = true;
            case {'no-s2-som', 'no-2s-som'},
                disp('** S2-SOM Inactive, only SOM training **');
                bool_2ssom = false;
            case 'dimdata'
                DimData = varargin{i+1}; i=i+1;
                for di=1:length(DimData)
                    DimBloc(di).Dim = DimData(di);
                end
                bool_DimData = true;
            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
                if isscalar(lambda) && lambda <= 0
                    bool_lambda = false;
                else
                    bool_lambda = true;
                end
            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
                if isscalar(eta) && eta <= 0
                    bool_eta = false;
                else
                    bool_eta = true;
                end
            case 'parcomp'
                bool_parcomp = true;
                parcomp_workers = varargin{i+1}; i=i+1;
            case 'ini-with-make'
                bool_init_with_make = true;
            case 'no-ini-with-make'
                bool_init_with_make = false;
            case 'pre-training'
                bool_pre_training   = true;
            case 'no-pre-training'
                bool_pre_training   = false;
            otherwise
                error(sprintf(' *** %s error: argument(%d) ''%s'' inconnu ***\n', ...
                    mfilename, i, varargin{i}));
        end
175
    else
176 177
        error(sprintf(' *** %s error: argument non-string inattendu (en %d-iemme position) ***\n', ...
            mfilename, i));
178 179
    end
    i=i+1;
180
end
181

182
if isempty(ListVar),
183 184
    kVar = 1;
    for iG = 1:length(DimData),
185 186 187 188 189
        szG = DimData(iG);
        for l = 1:szG
            ListVar{kVar,1} = sprintf('Gr%dVar%d', iG, l);
            kVar = kVar + 1;
        end
190
    end
191
end
192

193
data.colheaders = ListVar;
194

195 196 197 198 199 200 201 202 203 204 205 206
sD = som_data_struct(data.data,'name', data_casename,'comp_names', upper(ListVar));
% 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

%normalisation des donnees
if bool_norm
207 208
    fprintf(1,'\n-- Normalisation des donnees selon ''%s'' ...\n', type_norm);
    if strcmp(type_norm,'simple')
209
        sD_norm=som_normalize(sD);
210
    else
211
        sD_norm=som_normalize(sD,type_norm);
212
    end
213
else
214
    fprintf(1,'\n** Pas de normalisation des donnees **\n');
215
    sD_norm = sD;
216
end
217

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

% 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

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

%SOM initialisation
if bool_init_with_make
243
    fprintf(1,'\n-- Initialisation avec SOM_MAKE ... ')
244
    sMap=som_make(sD_norm, ...
245 246 247 248 249 250
        'munits',   nb_neurone, ...
        'lattice',  lattice, ...
        'init',     init, ...
        'tracking', tracking); % creer la carte initiale avec et effectuer un entrainenemt
    
else
251
    if strcmp(init,'randinit')
252 253 254 255 256 257
        fprintf(1,'\n-- Initialisation avec SOM_RANDINIT ... ')
        sMap=som_randinit(sD_norm, ...
            'munits',   nb_neurone, ...
            'lattice',  lattice, ...
            'tracking', tracking); % creer la carte initiale
        
258
    elseif strcmp(init,'lininit')
259 260 261 262 263 264
        fprintf(1,'\n-- Initialisation avec SOM_LININIT ... ')
        sMap=som_lininit(sD_norm, ...
            'munits',   nb_neurone, ...
            'lattice',  lattice, ...
            'tracking', tracking); % creer la carte initiale
        
265
    else
266 267 268
        error(sprintf(['\n *** %s error: invalid ''init'' option ''%s'' ***\n', ...
            '     Shoud be one between { ''lininit'', ''randinit'' } ***\n' ], ...
            mfilename, init));
269 270
    end
    fprintf(1,' <som init END>.\n')
271
end
272 273 274 275 276
fprintf(1,'\n   - msize ......... [%s]\n',join(string(sMap.topol.msize),', '));
fprintf(1,'   - lattice ....... ''%s''\n',sMap.topol.lattice);
fprintf(1,'-- Training data:\n')
fprintf(1,'   - radius ........ [%s]\n',join(string(rad),', '));
fprintf(1,'   - trainlen ...... [%s]\n',join(string(trlen),', '));
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302

% 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
303

304
if bool_pre_training
305 306
    pretrain_tracking = tracking;
    %pretrain_tracking = 1;
307
    
308 309
    % batchtrain avec radius ...
    if (bool_rad && ~bool_trainlen)
310 311 312 313 314 315 316 317 318 319 320
        fprintf(1,'\n-- BATCHTRAIN initial avec radius ... ')
        if pretrain_tracking, fprintf(1,'\n'); end
        j=1;
        while j<length(rad)
            
            sMap=som_batchtrain(sMap, sD_norm, ...
                'radius',[rad(j) rad(j+1)], ...
                'tracking',pretrain_tracking);
            j=j+1;
            
        end
321
    end
322
    % batchtrain avec trainlen ...
323 324 325 326 327 328 329 330 331 332 333 334
    if (~bool_rad && bool_trainlen)
        fprintf(1,'\n-- BATCHTRAIN initial avec trainlen ... ')
        if pretrain_tracking, fprintf(1,'\n'); end
        j=1;
        while j<=length(trlen)
            
            sMap=som_batchtrain(sMap, sD_norm, ...
                'trainlen',trlen(j), ...
                'tracking',pretrain_tracking);
            j=j+1;
            
        end
335
    end
336
    % batchtrain avec radius et trainlen
337
    if (bool_rad && bool_trainlen)
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
        fprintf(1,'\n-- BATCHTRAIN initial avec radius et trainlen ... \n')
        if pretrain_tracking, fprintf(1,'\n'); end
        if length(rad)==length(trlen)+1
            
            j=1;
            while j<length(rad)
                
                sMap=som_batchtrain(sMap, sD_norm, ...
                    'radius',[rad(j) rad(j+1)], ...
                    'trainlen',trlen(j), ...
                    'tracking',pretrain_tracking);
                j=j+1;
                
            end
        else
            error('vecteur radius doit avoir un element en plus que le vecteur trainlen ')
354
        end
355
    end
356
    sMapPT = sMap;
357
    
358 359 360
    current_perf = som_distortion(sMap,sD_norm);
    fprintf(1,'--> som_distortion apres entrainement initiale = %s\n', num2str(current_perf));
    
361
else
362
    fprintf(1,'** batchtrain initial (pre-training) non active **\n')
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
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
411

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
if (bool_2ssom)
    %if (bool_lambda && bool_eta && bool_DimData)
    if (bool_lambda && bool_eta)
        
        n_lambda = length(lambda);
        n_eta    = length(eta);
        i_train = 1;
        n_train = n_lambda*n_eta;
        
        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
428 429
        fprintf(1,'   - rad_2s_som .... [%s]\n',join(string(rad_2s_som),', '));
        fprintf(1,'   - trlen_2s_som .. [%s]\n',join(string(trlen_2s_som),', '));
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
        
        fprintf(1,[ '\n-- batchtrainRTOM loop for %d lambda and %d eta values:\n', ...
            '-- ------------------------------------------------------------------\n' ], ...
            n_lambda, n_eta);
        if tracking > 1,
            fprintf(1,'   ... trainlen_2s_som ... %s\n', num2str(trlen_2s_som))
            fprintf(1,'   ... radius_2s_som ..... [%s]\n', join(string(rad_2s_som),', '))
        end
        if bool_parcomp, ticBytes(gcp); end   % POUR CALCUL PARALLELE
        if bool_parcomp
            parcomp_M = parcomp_workers;
        else
            parcomp_M = 1;
        end
        parfor (i=1:n_lambda,parcomp_M)
445 446 447
        %for i = 1:n_lambda
            ResultIJ = struct([]);
            for j = 1:n_eta
448 449 450 451 452
                fprintf(1,[ '-- batchtrainRTOM (%d/%d) %d train iterations', ...
                    ' [R: %s], with lambda=%s and eta=%s ... ' ], ...
                    (i - 1) * n_eta + j, n_train, trlen_2s_som, ...
                    join(string(rad_2s_som),'-'), ...
                    num2str(lambda(i)), num2str(eta(j)));
453 454
                if tracking, fprintf(1,'\n'); end
                
455
                [ResultIJ(1).sMap, ResultIJ(1).bmus, ResultIJ(1).Alpha, ResultIJ(1).Beta] = som_batchtrainRTOM( ...
456 457 458 459 460 461 462 463 464 465
                    sMap, sD_norm, ...
                    'TypeAlgo', '2SSOM', ...
                    'DimData',  DimData, ...
                    'DimBloc',  DimBloc, ...
                    'lambda',   lambda(i), ...
                    'eta',      eta(j), ...
                    'radius',   rad_2s_som, ...
                    'trainlen', trlen_2s_som, ...
                    'tracking', tracking);
                
466 467 468
                ResultIJ(1).lambda  = lambda(i);
                ResultIJ(1).eta     = eta(j);
                ResultIJ(1).DimData = DimData;
469
                
470
                current_perf = som_distortion(ResultIJ(1).sMap,sD_norm);
471 472
                fprintf(1,'   --> som_distortion=%s\n', num2str(current_perf));
                
473 474 475 476 477 478 479 480 481 482 483
                ResultIJ(1).Perf = current_perf;
                
                LoopResult(i,j).fields = fields(ResultIJ);
                LoopResult(i,j).values = struct2cell(ResultIJ);
            end
        end
        for ij = 1:length(LoopResult)
            if ij == 1
                Result = cell2struct(LoopResult(ij).values,LoopResult(ij).fields);
            else
                Result(ij) = cell2struct(LoopResult(ij).values,LoopResult(ij).fields);
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
            end
        end
        if bool_parcomp, tocBytes(gcp), end   % POUR CALCUL PARALLELE
        
        % best_i   = 0;
        % best_j   = 0;
        % bestperf = inf;
        % for i=1:n_lambda
        %   for j=1:n_eta
        %       %  end
        %       %end
        %       % best_i=0;
        %       % best_j=0;
        %       % bestperf=inf;
        %       % for i=1:n_lambda
        %       %   for j=1:n_eta
        %       %
        %       if Result(i,j).Perf < bestperf
        %           best_i = i;
        %           best_j = j;
        %           bestperf = Result(i,j).Perf;
        %       end
        %   end
        % end
        %
        % sMap = Result(best_i,best_j).sMap;
        
    else
        error('manque de parametre: specifier les valeurs pour LAMBDA, pour ETA ou pour les deux!')
    end
elseif (bool_lambda || bool_eta)
515
    error([ '*** %s: PAS DE 2SSOM SPECIFIE MAIS FLAGS (LAMBDA ou ETA) ACTIVE ***\n', ...
516 517
        '    mentionnez si vous voulez ''S2-SOM''\n' ], mfilename)
else
518
    fprintf(1,[ '*** %s: PAS DE 2SSOM SPECIFIE ***\n', ...
519 520 521 522 523 524 525
        '    mentionnez si vous voulez ''S2-SOM''\n' ], mfilename)
end

% end

clear St
if (bool_2ssom)
526 527 528 529
    % si 2S-SOM alors best perf sMap
    [BestPerf,iBest] = min(cell2mat({Result.Perf}));
    
    sMap = Result(iBest).sMap;
530
else
531 532
    % sinon, si pas 2S-SOM
    sMap = sMapPT;
533 534 535 536
end

% denormalisation de la Map
if bool_norm
537
    sMap_dnrm = som_denormalize(sMap,sD_norm.comp_norm);
538
else
539
    sMap_dnrm = sMap;
540 541 542
end

if bool_return_struct
543 544
    % Si retour STRUCT
    St.sMap     = sMap;
545
    St.sD       = sD;
546 547
    
    if ~bool_2ssom
548
        St.bmus = som_bmus(sMap,sD);
549 550
    end
    
551
    if bool_norm
552 553
        St.sMap_denorm = sMap_dnrm;
        St.sD_norm = sD_norm;
554 555 556
    end
    
    if (bool_2ssom)
557 558 559 560 561 562 563 564 565 566 567 568 569 570
        St.lambda  = Result(iBest).lambda;
        St.eta     = Result(iBest).eta;
        St.bmus    = Result(iBest).bmus;
        St.Alpha   = Result(iBest).Alpha;
        St.Beta    = Result(iBest).Beta;
        St.DimData = Result(iBest).DimData;
        
        St.sMapPT   = sMapPT;
        if bool_norm
            St.sMapPT_denorm = som_denormalize(sMapPT,sD_norm.comp_norm);
        end
        
        St.Result   = Result;
        St.iBest    = iBest;
571 572 573
    end
    
    StsMap = St; % variable de retour
574
else
575 576 577 578 579
    % Sinon, alors retour variables  ... (sMap sMap_denorm Result)
    StsMap      = sMap;
    sMap_denorm = sMap_dnrm;
    Resultout   = Result;
    sMapPTout   = sMapPT;
580 581 582
end

return