source: branches/TSNE/HeuristicLab.Algorithms.DataAnalysis/3.4/TSNE/TSNEAlgorithm.cs @ 14859

Last change on this file since 14859 was 14859, checked in by gkronber, 2 years ago

#2700 update only every x iterations and fixed output paths

File size: 21.0 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2016 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Drawing;
25using System.Linq;
26using System.Threading;
27using HeuristicLab.Analysis;
28using HeuristicLab.Common;
29using HeuristicLab.Core;
30using HeuristicLab.Data;
31using HeuristicLab.Optimization;
32using HeuristicLab.Parameters;
33using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
34using HeuristicLab.Problems.DataAnalysis;
35using HeuristicLab.Random;
36
37namespace HeuristicLab.Algorithms.DataAnalysis {
38  /// <summary>
39  /// t-distributed stochastic neighbourhood embedding (tSNE) projects the data in a low dimensional
40  /// space to allow visual cluster identification.
41  /// </summary>
42  [Item("tSNE", "t-distributed stochastic neighbourhood embedding projects the data in a low " +
43                "dimensional space to allow visual cluster identification.")]
44  [Creatable(CreatableAttribute.Categories.DataAnalysis, Priority = 100)]
45  [StorableClass]
46  public sealed class TSNEAlgorithm : BasicAlgorithm {
47    public override bool SupportsPause {
48      get { return true; }
49    }
50    public override Type ProblemType {
51      get { return typeof(IDataAnalysisProblem); }
52    }
53    public new IDataAnalysisProblem Problem {
54      get { return (IDataAnalysisProblem)base.Problem; }
55      set { base.Problem = value; }
56    }
57
58    #region parameter names
59    private const string DistanceParameterName = "DistanceFunction";
60    private const string PerplexityParameterName = "Perplexity";
61    private const string ThetaParameterName = "Theta";
62    private const string NewDimensionsParameterName = "Dimensions";
63    private const string MaxIterationsParameterName = "MaxIterations";
64    private const string StopLyingIterationParameterName = "StopLyingIteration";
65    private const string MomentumSwitchIterationParameterName = "MomentumSwitchIteration";
66    private const string InitialMomentumParameterName = "InitialMomentum";
67    private const string FinalMomentumParameterName = "FinalMomentum";
68    private const string EtaParameterName = "Eta";
69    private const string SetSeedRandomlyParameterName = "SetSeedRandomly";
70    private const string SeedParameterName = "Seed";
71    private const string ClassesParameterName = "ClassNames";
72    private const string NormalizationParameterName = "Normalization";
73    private const string UpdateIntervalParameterName = "UpdateInterval";
74    #endregion
75
76    #region result names
77    private const string IterationResultName = "Iteration";
78    private const string ErrorResultName = "Error";
79    private const string ErrorPlotResultName = "Error plot";
80    private const string ScatterPlotResultName = "Scatterplot";
81    private const string DataResultName = "Projected data";
82    #endregion
83
84    #region parameter properties
85    public IFixedValueParameter<DoubleValue> PerplexityParameter {
86      get { return Parameters[PerplexityParameterName] as IFixedValueParameter<DoubleValue>; }
87    }
88    public IFixedValueParameter<DoubleValue> ThetaParameter {
89      get { return Parameters[ThetaParameterName] as IFixedValueParameter<DoubleValue>; }
90    }
91    public IFixedValueParameter<IntValue> NewDimensionsParameter {
92      get { return Parameters[NewDimensionsParameterName] as IFixedValueParameter<IntValue>; }
93    }
94    public IValueParameter<IDistance<double[]>> DistanceParameter {
95      get { return Parameters[DistanceParameterName] as IValueParameter<IDistance<double[]>>; }
96    }
97    public IFixedValueParameter<IntValue> MaxIterationsParameter {
98      get { return Parameters[MaxIterationsParameterName] as IFixedValueParameter<IntValue>; }
99    }
100    public IFixedValueParameter<IntValue> StopLyingIterationParameter {
101      get { return Parameters[StopLyingIterationParameterName] as IFixedValueParameter<IntValue>; }
102    }
103    public IFixedValueParameter<IntValue> MomentumSwitchIterationParameter {
104      get { return Parameters[MomentumSwitchIterationParameterName] as IFixedValueParameter<IntValue>; }
105    }
106    public IFixedValueParameter<DoubleValue> InitialMomentumParameter {
107      get { return Parameters[InitialMomentumParameterName] as IFixedValueParameter<DoubleValue>; }
108    }
109    public IFixedValueParameter<DoubleValue> FinalMomentumParameter {
110      get { return Parameters[FinalMomentumParameterName] as IFixedValueParameter<DoubleValue>; }
111    }
112    public IFixedValueParameter<DoubleValue> EtaParameter {
113      get { return Parameters[EtaParameterName] as IFixedValueParameter<DoubleValue>; }
114    }
115    public IFixedValueParameter<BoolValue> SetSeedRandomlyParameter {
116      get { return Parameters[SetSeedRandomlyParameterName] as IFixedValueParameter<BoolValue>; }
117    }
118    public IFixedValueParameter<IntValue> SeedParameter {
119      get { return Parameters[SeedParameterName] as IFixedValueParameter<IntValue>; }
120    }
121    public IFixedValueParameter<StringValue> ClassesParameter {
122      get { return Parameters[ClassesParameterName] as IFixedValueParameter<StringValue>; }
123    }
124    public IFixedValueParameter<BoolValue> NormalizationParameter {
125      get { return Parameters[NormalizationParameterName] as IFixedValueParameter<BoolValue>; }
126    }
127    public IFixedValueParameter<IntValue> UpdateIntervalParameter {
128      get { return Parameters[UpdateIntervalParameterName] as IFixedValueParameter<IntValue>; }
129    }
130    #endregion
131
132    #region  Properties
133    public IDistance<double[]> Distance {
134      get { return DistanceParameter.Value; }
135    }
136    public double Perplexity {
137      get { return PerplexityParameter.Value.Value; }
138      set { PerplexityParameter.Value.Value = value; }
139    }
140    public double Theta {
141      get { return ThetaParameter.Value.Value; }
142      set { ThetaParameter.Value.Value = value; }
143    }
144    public int NewDimensions {
145      get { return NewDimensionsParameter.Value.Value; }
146      set { NewDimensionsParameter.Value.Value = value; }
147    }
148    public int MaxIterations {
149      get { return MaxIterationsParameter.Value.Value; }
150      set { MaxIterationsParameter.Value.Value = value; }
151    }
152    public int StopLyingIteration {
153      get { return StopLyingIterationParameter.Value.Value; }
154      set { StopLyingIterationParameter.Value.Value = value; }
155    }
156    public int MomentumSwitchIteration {
157      get { return MomentumSwitchIterationParameter.Value.Value; }
158      set { MomentumSwitchIterationParameter.Value.Value = value; }
159    }
160    public double InitialMomentum {
161      get { return InitialMomentumParameter.Value.Value; }
162      set { InitialMomentumParameter.Value.Value = value; }
163    }
164    public double FinalMomentum {
165      get { return FinalMomentumParameter.Value.Value; }
166      set { FinalMomentumParameter.Value.Value = value; }
167    }
168    public double Eta {
169      get { return EtaParameter.Value.Value; }
170      set { EtaParameter.Value.Value = value; }
171    }
172    public bool SetSeedRandomly {
173      get { return SetSeedRandomlyParameter.Value.Value; }
174      set { SetSeedRandomlyParameter.Value.Value = value; }
175    }
176    public int Seed {
177      get { return SeedParameter.Value.Value; }
178      set { SeedParameter.Value.Value = value; }
179    }
180    public string Classes {
181      get { return ClassesParameter.Value.Value; }
182      set { ClassesParameter.Value.Value = value; }
183    }
184    public bool Normalization {
185      get { return NormalizationParameter.Value.Value; }
186      set { NormalizationParameter.Value.Value = value; }
187    }
188
189    public int UpdateInterval {
190      get { return UpdateIntervalParameter.Value.Value; }
191      set { UpdateIntervalParameter.Value.Value = value; }
192    }
193    #endregion
194
195    #region Constructors & Cloning
196    [StorableConstructor]
197    private TSNEAlgorithm(bool deserializing) : base(deserializing) { }
198
199    private TSNEAlgorithm(TSNEAlgorithm original, Cloner cloner) : base(original, cloner) {
200      this.dataRowNames = new Dictionary<string, List<int>>(original.dataRowNames);
201      this.dataRows = original.dataRows.ToDictionary(kvp => kvp.Key, kvp => cloner.Clone(kvp.Value));
202      if (original.state != null)
203        this.state = cloner.Clone(original.state);
204      this.iter = original.iter;
205    }
206    public override IDeepCloneable Clone(Cloner cloner) { return new TSNEAlgorithm(this, cloner); }
207    public TSNEAlgorithm() {
208      Problem = new RegressionProblem();
209      Parameters.Add(new ValueParameter<IDistance<double[]>>(DistanceParameterName, "The distance function used to differentiate similar from non-similar points", new EuclideanDistance()));
210      Parameters.Add(new FixedValueParameter<DoubleValue>(PerplexityParameterName, "Perplexity-parameter of tSNE. Comparable to k in a k-nearest neighbour algorithm. Recommended value is floor(number of points /3) or lower", new DoubleValue(25)));
211      Parameters.Add(new FixedValueParameter<DoubleValue>(ThetaParameterName, "Value describing how much appoximated " +
212                                                                              "gradients my differ from exact gradients. Set to 0 for exact calculation and in [0,1] otherwise. " +
213                                                                              "Appropriate values for theta are between 0.1 and 0.7 (default = 0.5). CAUTION: exact calculation of " +
214                                                                              "forces requires building a non-sparse N*N matrix where N is the number of data points. This may " +
215                                                                              "exceed memory limitations. The function is designed to run on large (N > 5000) data sets. It may give" +
216                                                                              " poor performance on very small data sets(it is better to use a standard t - SNE implementation on such data).", new DoubleValue(0)));
217      Parameters.Add(new FixedValueParameter<IntValue>(NewDimensionsParameterName, "Dimensionality of projected space (usually 2 for easy visual analysis)", new IntValue(2)));
218      Parameters.Add(new FixedValueParameter<IntValue>(MaxIterationsParameterName, "Maximum number of iterations for gradient descent.", new IntValue(1000)));
219      Parameters.Add(new FixedValueParameter<IntValue>(StopLyingIterationParameterName, "Number of iterations after which p is no longer approximated.", new IntValue(0)));
220      Parameters.Add(new FixedValueParameter<IntValue>(MomentumSwitchIterationParameterName, "Number of iterations after which the momentum in the gradient descent is switched.", new IntValue(0)));
221      Parameters.Add(new FixedValueParameter<DoubleValue>(InitialMomentumParameterName, "The initial momentum in the gradient descent.", new DoubleValue(0.5)));
222      Parameters.Add(new FixedValueParameter<DoubleValue>(FinalMomentumParameterName, "The final momentum.", new DoubleValue(0.8)));
223      Parameters.Add(new FixedValueParameter<DoubleValue>(EtaParameterName, "Gradient descent learning rate.", new DoubleValue(10)));
224      Parameters.Add(new FixedValueParameter<BoolValue>(SetSeedRandomlyParameterName, "If the seed should be random.", new BoolValue(true)));
225      Parameters.Add(new FixedValueParameter<IntValue>(SeedParameterName, "The seed used if it should not be random.", new IntValue(0)));
226      Parameters.Add(new FixedValueParameter<StringValue>(ClassesParameterName, "name of the column specifying the class lables of each data point. If the label column can not be found training/test is used as labels.", new StringValue("none")));
227      Parameters.Add(new FixedValueParameter<BoolValue>(NormalizationParameterName, "Whether the data should be zero centered and have variance of 1 for each variable, so different scalings are ignored.", new BoolValue(true)));
228      Parameters.Add(new FixedValueParameter<IntValue>(UpdateIntervalParameterName, "", new IntValue(50)));
229      Parameters[UpdateIntervalParameterName].Hidden = true;
230
231      MomentumSwitchIterationParameter.Hidden = true;
232      InitialMomentumParameter.Hidden = true;
233      FinalMomentumParameter.Hidden = true;
234      StopLyingIterationParameter.Hidden = true;
235      EtaParameter.Hidden = false;
236    }
237    #endregion
238
239    [Storable]
240    private Dictionary<string, List<int>> dataRowNames;
241    [Storable]
242    private Dictionary<string, ScatterPlotDataRow> dataRows;
243    [Storable]
244    private TSNEStatic<double[]>.TSNEState state;
245    [Storable]
246    private int iter;
247
248    public override void Prepare() {
249      base.Prepare();
250      dataRowNames = null;
251      dataRows = null;
252      state = null;
253    }
254
255    protected override void Run(CancellationToken cancellationToken) {
256      var problemData = Problem.ProblemData;
257      // set up and initialized everything if necessary
258      if (state == null) {
259        if (SetSeedRandomly) Seed = new System.Random().Next();
260        var random = new MersenneTwister((uint)Seed);
261        var dataset = problemData.Dataset;
262        var allowedInputVariables = problemData.AllowedInputVariables.ToArray();
263        var data = new double[dataset.Rows][];
264        for (var row = 0; row < dataset.Rows; row++)
265          data[row] = allowedInputVariables.Select(col => dataset.GetDoubleValue(col, row)).ToArray();
266
267        if (Normalization) data = NormalizeData(data);
268
269        state = TSNEStatic<double[]>.CreateState(data, Distance, random, NewDimensions, Perplexity, Theta,
270          StopLyingIteration, MomentumSwitchIteration, InitialMomentum, FinalMomentum, Eta);
271
272        SetUpResults(data);
273        iter = 0;
274      }
275      for (; iter < MaxIterations && !cancellationToken.IsCancellationRequested; iter++) {
276        if (iter % UpdateInterval == 0)
277          Analyze(state);
278        TSNEStatic<double[]>.Iterate(state);
279      }
280      Analyze(state);
281    }
282
283    private void SetUpResults(IReadOnlyCollection<double[]> data) {
284      if (Results == null) return;
285      var results = Results;
286      dataRowNames = new Dictionary<string, List<int>>();
287      dataRows = new Dictionary<string, ScatterPlotDataRow>();
288      var problemData = Problem.ProblemData;
289
290      //color datapoints acording to classes variable (be it double or string)
291      if (problemData.Dataset.VariableNames.Contains(Classes)) {
292        if ((problemData.Dataset as Dataset).VariableHasType<string>(Classes)) {
293          var classes = problemData.Dataset.GetStringValues(Classes).ToArray();
294          for (var i = 0; i < classes.Length; i++) {
295            if (!dataRowNames.ContainsKey(classes[i])) dataRowNames.Add(classes[i], new List<int>());
296            dataRowNames[classes[i]].Add(i);
297          }
298        } else if ((problemData.Dataset as Dataset).VariableHasType<double>(Classes)) {
299          var classValues = problemData.Dataset.GetDoubleValues(Classes).ToArray();
300          var max = classValues.Max() + 0.1;
301          var min = classValues.Min() - 0.1;
302          const int contours = 8;
303          for (var i = 0; i < contours; i++) {
304            var contourname = GetContourName(i, min, max, contours);
305            dataRowNames.Add(contourname, new List<int>());
306            dataRows.Add(contourname, new ScatterPlotDataRow(contourname, "", new List<Point2D<double>>()));
307            dataRows[contourname].VisualProperties.Color = GetHeatMapColor(i, contours);
308            dataRows[contourname].VisualProperties.PointSize = i + 3;
309          }
310          for (var i = 0; i < classValues.Length; i++) {
311            dataRowNames[GetContourName(classValues[i], min, max, contours)].Add(i);
312          }
313        }
314      } else {
315        dataRowNames.Add("Training", problemData.TrainingIndices.ToList());
316        dataRowNames.Add("Test", problemData.TestIndices.ToList());
317      }
318
319      if (!results.ContainsKey(IterationResultName)) results.Add(new Result(IterationResultName, new IntValue(0)));
320      else ((IntValue)results[IterationResultName].Value).Value = 0;
321
322      if (!results.ContainsKey(ErrorResultName)) results.Add(new Result(ErrorResultName, new DoubleValue(0)));
323      else ((DoubleValue)results[ErrorResultName].Value).Value = 0;
324
325      if (!results.ContainsKey(ErrorPlotResultName)) results.Add(new Result(ErrorPlotResultName, new DataTable(ErrorPlotResultName, "Development of errors during gradient descent")));
326      else results[ErrorPlotResultName].Value = new DataTable(ErrorPlotResultName, "Development of errors during gradient descent");
327
328      var plot = results[ErrorPlotResultName].Value as DataTable;
329      if (plot == null) throw new ArgumentException("could not create/access error data table in results collection");
330
331      if (!plot.Rows.ContainsKey("errors")) plot.Rows.Add(new DataRow("errors"));
332      plot.Rows["errors"].Values.Clear();
333      plot.Rows["errors"].VisualProperties.StartIndexZero = true;
334
335      results.Add(new Result(ScatterPlotResultName, "Plot of the projected data", new ScatterPlot(DataResultName, "")));
336      results.Add(new Result(DataResultName, "Projected Data", new DoubleMatrix()));
337    }
338
339    private void Analyze(TSNEStatic<double[]>.TSNEState tsneState) {
340      if (Results == null) return;
341      var results = Results;
342      var plot = results[ErrorPlotResultName].Value as DataTable;
343      if (plot == null) throw new ArgumentException("Could not create/access error data table in results collection.");
344      var errors = plot.Rows["errors"].Values;
345      var c = tsneState.EvaluateError();
346      errors.Add(c);
347      ((IntValue)results[IterationResultName].Value).Value = tsneState.iter;
348      ((DoubleValue)results[ErrorResultName].Value).Value = errors.Last();
349
350      var ndata = Normalize(tsneState.newData);
351      results[DataResultName].Value = new DoubleMatrix(ndata);
352      var splot = results[ScatterPlotResultName].Value as ScatterPlot;
353      FillScatterPlot(ndata, splot);
354    }
355
356    private void FillScatterPlot(double[,] lowDimData, ScatterPlot plot) {
357      foreach (var rowName in dataRowNames.Keys) {
358        if (!plot.Rows.ContainsKey(rowName))
359          plot.Rows.Add(dataRows.ContainsKey(rowName) ? dataRows[rowName] : new ScatterPlotDataRow(rowName, "", new List<Point2D<double>>()));
360        plot.Rows[rowName].Points.Replace(dataRowNames[rowName].Select(i => new Point2D<double>(lowDimData[i, 0], lowDimData[i, 1])));
361      }
362    }
363
364    private static double[,] Normalize(double[,] data) {
365      var max = new double[data.GetLength(1)];
366      var min = new double[data.GetLength(1)];
367      var res = new double[data.GetLength(0), data.GetLength(1)];
368      for (var i = 0; i < max.Length; i++) max[i] = min[i] = data[0, i];
369      for (var i = 0; i < data.GetLength(0); i++)
370        for (var j = 0; j < data.GetLength(1); j++) {
371          var v = data[i, j];
372          max[j] = Math.Max(max[j], v);
373          min[j] = Math.Min(min[j], v);
374        }
375      for (var i = 0; i < data.GetLength(0); i++) {
376        for (var j = 0; j < data.GetLength(1); j++) {
377          res[i, j] = (data[i, j] - (max[j] + min[j]) / 2) / (max[j] - min[j]);
378        }
379      }
380      return res;
381    }
382
383    private static double[][] NormalizeData(IReadOnlyList<double[]> data) {
384      // as in tSNE implementation by van der Maaten
385      var n = data[0].Length;
386      var mean = new double[n];
387      var max = new double[n];
388      var nData = new double[data.Count][];
389      for (var i = 0; i < n; i++) {
390        mean[i] = Enumerable.Range(0, data.Count).Select(x => data[x][i]).Average();
391        max[i] = Enumerable.Range(0, data.Count).Max(x => Math.Abs(data[x][i]));
392      }
393      for (var i = 0; i < data.Count; i++) {
394        nData[i] = new double[n];
395        for (var j = 0; j < n; j++) nData[i][j] = (data[i][j] - mean[j]) / max[j];
396      }
397      return nData;
398    }
399
400    private static Color GetHeatMapColor(int contourNr, int noContours) {
401      var q = (double)contourNr / noContours;  // q in [0,1]
402      var c = q < 0.5 ? Color.FromArgb((int)(q * 2 * 255), 255, 0) : Color.FromArgb(255, (int)((1 - q) * 2 * 255), 0);
403      return c;
404    }
405
406    private static string GetContourName(double value, double min, double max, int noContours) {
407      var size = (max - min) / noContours;
408      var contourNr = (int)((value - min) / size);
409      return GetContourName(contourNr, min, max, noContours);
410    }
411
412    private static string GetContourName(int i, double min, double max, int noContours) {
413      var size = (max - min) / noContours;
414      return "[" + (min + i * size) + ";" + (min + (i + 1) * size) + ")";
415    }
416  }
417}
Note: See TracBrowser for help on using the repository browser.