Free cookie consent management tool by TermsFeed Policy Generator

source: branches/DataAnalysis/HeuristicLab.Problems.DataAnalysis.Regression/3.3/Symbolic/Analyzers/FixedValidationBestScaledSymbolicRegressionSolutionAnalyzer.cs @ 4202

Last change on this file since 4202 was 4202, checked in by gkronber, 14 years ago

Changed R² evaluator to return 0 when the estimated values contain NaN values. #1142.

File size: 20.6 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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.Collections.Generic;
23using System.Linq;
24using HeuristicLab.Analysis;
25using HeuristicLab.Core;
26using HeuristicLab.Data;
27using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding;
28using HeuristicLab.Operators;
29using HeuristicLab.Optimization;
30using HeuristicLab.Parameters;
31using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
32using HeuristicLab.Problems.DataAnalysis.Evaluators;
33using HeuristicLab.Problems.DataAnalysis.Symbolic;
34using System;
35
36namespace HeuristicLab.Problems.DataAnalysis.Regression.Symbolic.Analyzers {
37  /// <summary>
38  /// An operator that analyzes the validation best scaled symbolic regression solution.
39  /// </summary>
40  [Item("FixedValidationBestScaledSymbolicRegressionSolutionAnalyzer", "An operator that analyzes the validation best scaled symbolic regression solution.")]
41  [StorableClass]
42  public sealed class FixedValidationBestScaledSymbolicRegressionSolutionAnalyzer : SingleSuccessorOperator, ISymbolicRegressionAnalyzer {
43    private const string RandomParameterName = "Random";
44    private const string SymbolicExpressionTreeParameterName = "SymbolicExpressionTree";
45    private const string SymbolicExpressionTreeInterpreterParameterName = "SymbolicExpressionTreeInterpreter";
46    private const string ProblemDataParameterName = "ProblemData";
47    private const string ValidationSamplesStartParameterName = "SamplesStart";
48    private const string ValidationSamplesEndParameterName = "SamplesEnd";
49    // private const string QualityParameterName = "Quality";
50    private const string UpperEstimationLimitParameterName = "UpperEstimationLimit";
51    private const string LowerEstimationLimitParameterName = "LowerEstimationLimit";
52    private const string EvaluatorParameterName = "Evaluator";
53    private const string MaximizationParameterName = "Maximization";
54    private const string BestSolutionParameterName = "Best solution (validation)";
55    private const string BestSolutionQualityParameterName = "Best solution quality (validation)";
56    private const string CurrentBestValidationQualityParameterName = "Current best validation quality";
57    private const string BestSolutionQualityValuesParameterName = "Validation Quality";
58    private const string ResultsParameterName = "Results";
59    private const string VariableFrequenciesParameterName = "VariableFrequencies";
60    private const string BestKnownQualityParameterName = "BestKnownQuality";
61    private const string GenerationsParameterName = "Generations";
62    private const string RelativeNumberOfEvaluatedSamplesParameterName = "RelativeNumberOfEvaluatedSamples";
63
64    private const string TrainingMeanSquaredErrorQualityParameterName = "Mean squared error (training)";
65    private const string MinTrainingMeanSquaredErrorQualityParameterName = "Min mean squared error (training)";
66    private const string MaxTrainingMeanSquaredErrorQualityParameterName = "Max mean squared error (training)";
67    private const string AverageTrainingMeanSquaredErrorQualityParameterName = "Average mean squared error (training)";
68    private const string BestTrainingMeanSquaredErrorQualityParameterName = "Best mean squared error (training)";
69
70    private const string TrainingAverageRelativeErrorQualityParameterName = "Average relative error (training)";
71    private const string MinTrainingAverageRelativeErrorQualityParameterName = "Min average relative error (training)";
72    private const string MaxTrainingAverageRelativeErrorQualityParameterName = "Max average relative error (training)";
73    private const string AverageTrainingAverageRelativeErrorQualityParameterName = "Average average relative error (training)";
74    private const string BestTrainingAverageRelativeErrorQualityParameterName = "Best average relative error (training)";
75
76    private const string TrainingRSquaredQualityParameterName = "R² (training)";
77    private const string MinTrainingRSquaredQualityParameterName = "Min R² (training)";
78    private const string MaxTrainingRSquaredQualityParameterName = "Max R² (training)";
79    private const string AverageTrainingRSquaredQualityParameterName = "Average R² (training)";
80    private const string BestTrainingRSquaredQualityParameterName = "Best R² (training)";
81
82    private const string TestMeanSquaredErrorQualityParameterName = "Mean squared error (test)";
83    private const string MinTestMeanSquaredErrorQualityParameterName = "Min mean squared error (test)";
84    private const string MaxTestMeanSquaredErrorQualityParameterName = "Max mean squared error (test)";
85    private const string AverageTestMeanSquaredErrorQualityParameterName = "Average mean squared error (test)";
86    private const string BestTestMeanSquaredErrorQualityParameterName = "Best mean squared error (test)";
87
88    private const string TestAverageRelativeErrorQualityParameterName = "Average relative error (test)";
89    private const string MinTestAverageRelativeErrorQualityParameterName = "Min average relative error (test)";
90    private const string MaxTestAverageRelativeErrorQualityParameterName = "Max average relative error (test)";
91    private const string AverageTestAverageRelativeErrorQualityParameterName = "Average average relative error (test)";
92    private const string BestTestAverageRelativeErrorQualityParameterName = "Best average relative error (test)";
93
94    private const string TestRSquaredQualityParameterName = "R² (test)";
95    private const string MinTestRSquaredQualityParameterName = "Min R² (test)";
96    private const string MaxTestRSquaredQualityParameterName = "Max R² (test)";
97    private const string AverageTestRSquaredQualityParameterName = "Average R² (test)";
98    private const string BestTestRSquaredQualityParameterName = "Best R² (test)";
99
100    private const string RSquaredValuesParameterName = "R²";
101    private const string MeanSquaredErrorValuesParameterName = "Mean squared error";
102    private const string RelativeErrorValuesParameterName = "Average relative error";
103
104    #region parameter properties
105    public ILookupParameter<IRandom> RandomParameter {
106      get { return (ILookupParameter<IRandom>)Parameters[RandomParameterName]; }
107    }
108    public ScopeTreeLookupParameter<SymbolicExpressionTree> SymbolicExpressionTreeParameter {
109      get { return (ScopeTreeLookupParameter<SymbolicExpressionTree>)Parameters[SymbolicExpressionTreeParameterName]; }
110    }
111    public IValueLookupParameter<ISymbolicExpressionTreeInterpreter> SymbolicExpressionTreeInterpreterParameter {
112      get { return (IValueLookupParameter<ISymbolicExpressionTreeInterpreter>)Parameters[SymbolicExpressionTreeInterpreterParameterName]; }
113    }
114    public ILookupParameter<ISymbolicRegressionEvaluator> EvaluatorParameter {
115      get { return (ILookupParameter<ISymbolicRegressionEvaluator>)Parameters[EvaluatorParameterName]; }
116    }
117    public ILookupParameter<BoolValue> MaximizationParameter {
118      get { return (ILookupParameter<BoolValue>)Parameters[MaximizationParameterName]; }
119    }
120    public IValueLookupParameter<DataAnalysisProblemData> ProblemDataParameter {
121      get { return (IValueLookupParameter<DataAnalysisProblemData>)Parameters[ProblemDataParameterName]; }
122    }
123    public IValueLookupParameter<IntValue> ValidationSamplesStartParameter {
124      get { return (IValueLookupParameter<IntValue>)Parameters[ValidationSamplesStartParameterName]; }
125    }
126    public IValueLookupParameter<IntValue> ValidationSamplesEndParameter {
127      get { return (IValueLookupParameter<IntValue>)Parameters[ValidationSamplesEndParameterName]; }
128    }
129    public IValueParameter<PercentValue> RelativeNumberOfEvaluatedSamplesParameter {
130      get { return (IValueParameter<PercentValue>)Parameters[RelativeNumberOfEvaluatedSamplesParameterName]; }
131    }
132
133    public IValueLookupParameter<DoubleValue> UpperEstimationLimitParameter {
134      get { return (IValueLookupParameter<DoubleValue>)Parameters[UpperEstimationLimitParameterName]; }
135    }
136    public IValueLookupParameter<DoubleValue> LowerEstimationLimitParameter {
137      get { return (IValueLookupParameter<DoubleValue>)Parameters[LowerEstimationLimitParameterName]; }
138    }
139    public ILookupParameter<SymbolicRegressionSolution> BestSolutionParameter {
140      get { return (ILookupParameter<SymbolicRegressionSolution>)Parameters[BestSolutionParameterName]; }
141    }
142    public ILookupParameter<IntValue> GenerationsParameter {
143      get { return (ILookupParameter<IntValue>)Parameters[GenerationsParameterName]; }
144    }
145    public ILookupParameter<DoubleValue> BestSolutionQualityParameter {
146      get { return (ILookupParameter<DoubleValue>)Parameters[BestSolutionQualityParameterName]; }
147    }
148    public ILookupParameter<ResultCollection> ResultsParameter {
149      get { return (ILookupParameter<ResultCollection>)Parameters[ResultsParameterName]; }
150    }
151    public ILookupParameter<DoubleValue> BestKnownQualityParameter {
152      get { return (ILookupParameter<DoubleValue>)Parameters[BestKnownQualityParameterName]; }
153    }
154    public ILookupParameter<DataTable> VariableFrequenciesParameter {
155      get { return (ILookupParameter<DataTable>)Parameters[VariableFrequenciesParameterName]; }
156    }
157
158    #endregion
159    #region properties
160    public IRandom Random {
161      get { return RandomParameter.ActualValue; }
162    }
163    public ItemArray<SymbolicExpressionTree> SymbolicExpressionTree {
164      get { return SymbolicExpressionTreeParameter.ActualValue; }
165    }
166    public ISymbolicExpressionTreeInterpreter SymbolicExpressionTreeInterpreter {
167      get { return SymbolicExpressionTreeInterpreterParameter.ActualValue; }
168    }
169    public ISymbolicRegressionEvaluator Evaluator {
170      get { return EvaluatorParameter.ActualValue; }
171    }
172    public BoolValue Maximization {
173      get { return MaximizationParameter.ActualValue; }
174    }
175    public DataAnalysisProblemData ProblemData {
176      get { return ProblemDataParameter.ActualValue; }
177    }
178    public IntValue ValidiationSamplesStart {
179      get { return ValidationSamplesStartParameter.ActualValue; }
180    }
181    public IntValue ValidationSamplesEnd {
182      get { return ValidationSamplesEndParameter.ActualValue; }
183    }
184    public PercentValue RelativeNumberOfEvaluatedSamples {
185      get { return RelativeNumberOfEvaluatedSamplesParameter.Value; }
186    }
187
188    public DoubleValue UpperEstimationLimit {
189      get { return UpperEstimationLimitParameter.ActualValue; }
190    }
191    public DoubleValue LowerEstimationLimit {
192      get { return LowerEstimationLimitParameter.ActualValue; }
193    }
194    public ResultCollection Results {
195      get { return ResultsParameter.ActualValue; }
196    }
197    public DataTable VariableFrequencies {
198      get { return VariableFrequenciesParameter.ActualValue; }
199    }
200    public IntValue Generations {
201      get { return GenerationsParameter.ActualValue; }
202    }
203    public DoubleValue BestSolutionQuality {
204      get { return BestSolutionQualityParameter.ActualValue; }
205    }
206
207    #endregion
208
209    public FixedValidationBestScaledSymbolicRegressionSolutionAnalyzer()
210      : base() {
211      Parameters.Add(new LookupParameter<IRandom>(RandomParameterName, "The random generator to use."));
212      Parameters.Add(new LookupParameter<ISymbolicRegressionEvaluator>(EvaluatorParameterName, "The evaluator which should be used to evaluate the solution on the validation set."));
213      Parameters.Add(new ScopeTreeLookupParameter<SymbolicExpressionTree>(SymbolicExpressionTreeParameterName, "The symbolic expression trees to analyze."));
214      Parameters.Add(new LookupParameter<BoolValue>(MaximizationParameterName, "The direction of optimization."));
215      Parameters.Add(new ValueLookupParameter<ISymbolicExpressionTreeInterpreter>(SymbolicExpressionTreeInterpreterParameterName, "The interpreter that should be used for the analysis of symbolic expression trees."));
216      Parameters.Add(new ValueLookupParameter<DataAnalysisProblemData>(ProblemDataParameterName, "The problem data for which the symbolic expression tree is a solution."));
217      Parameters.Add(new ValueLookupParameter<IntValue>(ValidationSamplesStartParameterName, "The first index of the validation partition of the data set."));
218      Parameters.Add(new ValueLookupParameter<IntValue>(ValidationSamplesEndParameterName, "The last index of the validation partition of the data set."));
219      Parameters.Add(new ValueParameter<PercentValue>(RelativeNumberOfEvaluatedSamplesParameterName, "The relative number of samples of the dataset partition, which should be randomly chosen for evaluation between the start and end index.", new PercentValue(1)));
220      Parameters.Add(new ValueLookupParameter<DoubleValue>(UpperEstimationLimitParameterName, "The upper estimation limit that was set for the evaluation of the symbolic expression trees."));
221      Parameters.Add(new ValueLookupParameter<DoubleValue>(LowerEstimationLimitParameterName, "The lower estimation limit that was set for the evaluation of the symbolic expression trees."));
222      Parameters.Add(new LookupParameter<SymbolicRegressionSolution>(BestSolutionParameterName, "The best symbolic regression solution."));
223      Parameters.Add(new LookupParameter<IntValue>(GenerationsParameterName, "The number of generations calculated so far."));
224      Parameters.Add(new LookupParameter<DoubleValue>(BestSolutionQualityParameterName, "The quality of the best symbolic regression solution."));
225      Parameters.Add(new LookupParameter<ResultCollection>(ResultsParameterName, "The result collection where the best symbolic regression solution should be stored."));
226      Parameters.Add(new LookupParameter<DoubleValue>(BestKnownQualityParameterName, "The best known (validation) quality achieved on the data set."));
227      Parameters.Add(new LookupParameter<DataTable>(VariableFrequenciesParameterName, "The variable frequencies table to use for the calculation of variable impacts"));
228    }
229
230    [StorableConstructor]
231    private FixedValidationBestScaledSymbolicRegressionSolutionAnalyzer(bool deserializing) : base() { }
232
233    [StorableHook(HookType.AfterDeserialization)]
234    private void AfterDeserialization() {
235      #region compatibility remove before releasing 3.3.1
236      if (!Parameters.ContainsKey(EvaluatorParameterName)) {
237        Parameters.Add(new LookupParameter<ISymbolicRegressionEvaluator>(EvaluatorParameterName, "The evaluator which should be used to evaluate the solution on the validation set."));
238      }
239      if (!Parameters.ContainsKey(MaximizationParameterName)) {
240        Parameters.Add(new LookupParameter<BoolValue>(MaximizationParameterName, "The direction of optimization."));
241      }
242      #endregion
243    }
244
245    public override IOperation Apply() {
246      var trees = SymbolicExpressionTree;
247
248      string targetVariable = ProblemData.TargetVariable.Value;
249
250      // select a random subset of rows in the validation set
251      int validationStart = ValidiationSamplesStart.Value;
252      int validationEnd = ValidationSamplesEnd.Value;
253      uint seed = (uint)Random.Next();
254      int count = (int)((validationEnd - validationStart) * RelativeNumberOfEvaluatedSamples.Value);
255      if (count == 0) count = 1;
256      IEnumerable<int> rows = RandomEnumerable.SampleRandomNumbers(seed, validationStart, validationEnd, count);
257
258      double upperEstimationLimit = UpperEstimationLimit != null ? UpperEstimationLimit.Value : double.PositiveInfinity;
259      double lowerEstimationLimit = LowerEstimationLimit != null ? LowerEstimationLimit.Value : double.NegativeInfinity;
260
261      double bestQuality = Maximization.Value ? double.NegativeInfinity : double.PositiveInfinity;
262      SymbolicExpressionTree bestTree = null;
263
264      foreach (var tree in trees) {
265        double quality = Evaluator.Evaluate(SymbolicExpressionTreeInterpreter, tree,
266          lowerEstimationLimit, upperEstimationLimit,
267          ProblemData.Dataset, targetVariable,
268         rows);
269
270        if ((Maximization.Value && quality > bestQuality) ||
271            (!Maximization.Value && quality < bestQuality)) {
272          bestQuality = quality;
273          bestTree = tree;
274        }
275      }
276
277      // if the best validation tree is better than the current best solution => update
278      bool newBest =
279        BestSolutionQuality == null ||
280        (Maximization.Value && bestQuality > BestSolutionQuality.Value) ||
281        (!Maximization.Value && bestQuality < BestSolutionQuality.Value);
282      if (newBest) {
283        // calculate scaling parameters and only for the best tree using the full training set
284        double alpha, beta;
285        int trainingStart = ProblemData.TrainingSamplesStart.Value;
286        int trainingEnd = ProblemData.TrainingSamplesEnd.Value;
287        IEnumerable<int> trainingRows = Enumerable.Range(trainingStart, trainingEnd - trainingStart);
288        IEnumerable<double> originalValues = ProblemData.Dataset.GetEnumeratedVariableValues(targetVariable, trainingRows);
289        IEnumerable<double> estimatedValues =
290          GetBoundedValues(SymbolicExpressionTreeInterpreter.GetSymbolicExpressionTreeValues(bestTree, ProblemData.Dataset, trainingRows),
291            lowerEstimationLimit, upperEstimationLimit);
292
293
294        SymbolicRegressionScaledMeanSquaredErrorEvaluator.CalculateScalingParameters(originalValues, estimatedValues, out beta, out alpha);
295
296        // scale tree for solution
297        var scaledTree = SymbolicRegressionSolutionLinearScaler.Scale(bestTree, alpha, beta);
298        var model = new SymbolicRegressionModel((ISymbolicExpressionTreeInterpreter)SymbolicExpressionTreeInterpreter.Clone(),
299          scaledTree);
300        var solution = new SymbolicRegressionSolution(ProblemData, model, lowerEstimationLimit, upperEstimationLimit);
301        solution.Name = BestSolutionParameterName;
302        solution.Description = "Best solution on validation partition found over the whole run.";
303
304        BestSolutionParameter.ActualValue = solution;
305        BestSolutionQualityParameter.ActualValue = new DoubleValue(bestQuality);
306
307        BestSymbolicRegressionSolutionAnalyzer.UpdateBestSolutionResults(solution, ProblemData, Results, Generations, VariableFrequencies);
308      }
309
310
311      if (!Results.ContainsKey(BestSolutionQualityValuesParameterName)) {
312        Results.Add(new Result(BestSolutionQualityValuesParameterName, new DataTable(BestSolutionQualityValuesParameterName, BestSolutionQualityValuesParameterName)));
313        Results.Add(new Result(BestSolutionQualityParameterName, new DoubleValue()));
314        Results.Add(new Result(CurrentBestValidationQualityParameterName, new DoubleValue()));
315      }
316      Results[BestSolutionQualityParameterName].Value = new DoubleValue(BestSolutionQualityParameter.ActualValue.Value);
317      Results[CurrentBestValidationQualityParameterName].Value = new DoubleValue(bestQuality);
318
319      DataTable validationValues = (DataTable)Results[BestSolutionQualityValuesParameterName].Value;
320      AddValue(validationValues, BestSolutionQualityParameter.ActualValue.Value, BestSolutionQualityParameterName, BestSolutionQualityParameterName);
321      AddValue(validationValues, bestQuality, CurrentBestValidationQualityParameterName, CurrentBestValidationQualityParameterName);
322      return base.Apply();
323    }
324
325    private IEnumerable<double> GetBoundedValues(IEnumerable<double> values, double lowerEstimationLimit, double upperEstimationLimit) {
326      foreach (double v in values) {
327        if (double.IsNaN(v)) yield return upperEstimationLimit;
328        else yield return Math.Min(upperEstimationLimit, Math.Max(lowerEstimationLimit, v));
329      }
330    }
331
332    [StorableHook(HookType.AfterDeserialization)]
333    private void Initialize() { }
334
335    private static void AddValue(DataTable table, double data, string name, string description) {
336      DataRow row;
337      table.Rows.TryGetValue(name, out row);
338      if (row == null) {
339        row = new DataRow(name, description);
340        row.Values.Add(data);
341        table.Rows.Add(row);
342      } else {
343        row.Values.Add(data);
344      }
345    }
346  }
347}
Note: See TracBrowser for help on using the repository browser.