Free cookie consent management tool by TermsFeed Policy Generator

source: branches/PersistenceReintegration/HeuristicLab.Problems.DataAnalysis.Symbolic/3.4/SymbolicDataAnalysisProblem.cs @ 15018

Last change on this file since 15018 was 15018, checked in by gkronber, 8 years ago

#2520 introduced StorableConstructorFlag type for StorableConstructors
File size: 21.7 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.Drawing;
24using System.Linq;
25using HeuristicLab.Common;
26using HeuristicLab.Common.Resources;
27using HeuristicLab.Core;
28using HeuristicLab.Data;
29using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding;
30using HeuristicLab.Optimization;
31using HeuristicLab.Parameters;
32using HeuristicLab.Persistence;
33using HeuristicLab.PluginInfrastructure;
34using HeuristicLab.Problems.Instances;
35
36namespace HeuristicLab.Problems.DataAnalysis.Symbolic {
37  [StorableType("dec1cb4b-d759-4927-a176-dfbe3a71d474")]
38  public abstract class SymbolicDataAnalysisProblem<T, U, V> : HeuristicOptimizationProblem<U, V>, IDataAnalysisProblem<T>, ISymbolicDataAnalysisProblem, IStorableContent,
39    IProblemInstanceConsumer<T>, IProblemInstanceExporter<T>
40    where T : class, IDataAnalysisProblemData
41    where U : class, ISymbolicDataAnalysisEvaluator<T>
42    where V : class, ISymbolicDataAnalysisSolutionCreator {
43
44    #region parameter names & descriptions
45    private const string ProblemDataParameterName = "ProblemData";
46    private const string SymbolicExpressionTreeGrammarParameterName = "SymbolicExpressionTreeGrammar";
47    private const string SymbolicExpressionTreeInterpreterParameterName = "SymbolicExpressionTreeInterpreter";
48    private const string MaximumSymbolicExpressionTreeDepthParameterName = "MaximumSymbolicExpressionTreeDepth";
49    private const string MaximumSymbolicExpressionTreeLengthParameterName = "MaximumSymbolicExpressionTreeLength";
50    private const string MaximumFunctionDefinitionsParameterName = "MaximumFunctionDefinitions";
51    private const string MaximumFunctionArgumentsParameterName = "MaximumFunctionArguments";
52    private const string RelativeNumberOfEvaluatedSamplesParameterName = "RelativeNumberOfEvaluatedSamples";
53    private const string FitnessCalculationPartitionParameterName = "FitnessCalculationPartition";
54    private const string ValidationPartitionParameterName = "ValidationPartition";
55    private const string ApplyLinearScalingParameterName = "ApplyLinearScaling";
56
57    private const string ProblemDataParameterDescription = "";
58    private const string SymbolicExpressionTreeGrammarParameterDescription = "The grammar that should be used for symbolic expression tree.";
59    private const string SymoblicExpressionTreeInterpreterParameterDescription = "The interpreter that should be used to evaluate the symbolic expression tree.";
60    private const string MaximumSymbolicExpressionTreeDepthParameterDescription = "Maximal depth of the symbolic expression. The minimum depth needed for the algorithm is 3 because two levels are reserved for the ProgramRoot and the Start symbol.";
61    private const string MaximumSymbolicExpressionTreeLengthParameterDescription = "Maximal length of the symbolic expression.";
62    private const string MaximumFunctionDefinitionsParameterDescription = "Maximal number of automatically defined functions";
63    private const string MaximumFunctionArgumentsParameterDescription = "Maximal number of arguments of automatically defined functions.";
64    private const string RelativeNumberOfEvaluatedSamplesParameterDescription = "The relative number of samples of the dataset partition, which should be randomly chosen for evaluation.";
65    private const string FitnessCalculationPartitionParameterDescription = "The partition of the problem data training partition, that should be used to calculate the fitness of an individual.";
66    private const string ValidationPartitionParameterDescription = "The partition of the problem data training partition, that should be used to select the best model from (optional).";
67    private const string ApplyLinearScalingParameterDescription = "Flag that indicates if the individual should be linearly scaled before evaluating.";
68    #endregion
69
70    #region parameter properties
71    IParameter IDataAnalysisProblem.ProblemDataParameter {
72      get { return ProblemDataParameter; }
73    }
74    public IValueParameter<T> ProblemDataParameter {
75      get { return (IValueParameter<T>)Parameters[ProblemDataParameterName]; }
76    }
77    public IValueParameter<ISymbolicDataAnalysisGrammar> SymbolicExpressionTreeGrammarParameter {
78      get { return (IValueParameter<ISymbolicDataAnalysisGrammar>)Parameters[SymbolicExpressionTreeGrammarParameterName]; }
79    }
80    public IValueParameter<ISymbolicDataAnalysisExpressionTreeInterpreter> SymbolicExpressionTreeInterpreterParameter {
81      get { return (IValueParameter<ISymbolicDataAnalysisExpressionTreeInterpreter>)Parameters[SymbolicExpressionTreeInterpreterParameterName]; }
82    }
83    public IFixedValueParameter<IntValue> MaximumSymbolicExpressionTreeDepthParameter {
84      get { return (IFixedValueParameter<IntValue>)Parameters[MaximumSymbolicExpressionTreeDepthParameterName]; }
85    }
86    public IFixedValueParameter<IntValue> MaximumSymbolicExpressionTreeLengthParameter {
87      get { return (IFixedValueParameter<IntValue>)Parameters[MaximumSymbolicExpressionTreeLengthParameterName]; }
88    }
89    public IFixedValueParameter<IntValue> MaximumFunctionDefinitionsParameter {
90      get { return (IFixedValueParameter<IntValue>)Parameters[MaximumFunctionDefinitionsParameterName]; }
91    }
92    public IFixedValueParameter<IntValue> MaximumFunctionArgumentsParameter {
93      get { return (IFixedValueParameter<IntValue>)Parameters[MaximumFunctionArgumentsParameterName]; }
94    }
95    public IFixedValueParameter<PercentValue> RelativeNumberOfEvaluatedSamplesParameter {
96      get { return (IFixedValueParameter<PercentValue>)Parameters[RelativeNumberOfEvaluatedSamplesParameterName]; }
97    }
98    public IFixedValueParameter<IntRange> FitnessCalculationPartitionParameter {
99      get { return (IFixedValueParameter<IntRange>)Parameters[FitnessCalculationPartitionParameterName]; }
100    }
101    public IFixedValueParameter<IntRange> ValidationPartitionParameter {
102      get { return (IFixedValueParameter<IntRange>)Parameters[ValidationPartitionParameterName]; }
103    }
104    public IFixedValueParameter<BoolValue> ApplyLinearScalingParameter {
105      get { return (IFixedValueParameter<BoolValue>)Parameters[ApplyLinearScalingParameterName]; }
106    }
107    #endregion
108
109    #region properties
110    public string Filename { get; set; }
111    public static new Image StaticItemImage { get { return VSImageLibrary.Type; } }
112
113    IDataAnalysisProblemData IDataAnalysisProblem.ProblemData {
114      get { return ProblemData; }
115    }
116    public T ProblemData {
117      get { return ProblemDataParameter.Value; }
118      set { ProblemDataParameter.Value = value; }
119    }
120
121    public ISymbolicDataAnalysisGrammar SymbolicExpressionTreeGrammar {
122      get { return SymbolicExpressionTreeGrammarParameter.Value; }
123      set { SymbolicExpressionTreeGrammarParameter.Value = value; }
124    }
125    public ISymbolicDataAnalysisExpressionTreeInterpreter SymbolicExpressionTreeInterpreter {
126      get { return SymbolicExpressionTreeInterpreterParameter.Value; }
127      set { SymbolicExpressionTreeInterpreterParameter.Value = value; }
128    }
129
130    public IntValue MaximumSymbolicExpressionTreeDepth {
131      get { return MaximumSymbolicExpressionTreeDepthParameter.Value; }
132    }
133    public IntValue MaximumSymbolicExpressionTreeLength {
134      get { return MaximumSymbolicExpressionTreeLengthParameter.Value; }
135    }
136    public IntValue MaximumFunctionDefinitions {
137      get { return MaximumFunctionDefinitionsParameter.Value; }
138    }
139    public IntValue MaximumFunctionArguments {
140      get { return MaximumFunctionArgumentsParameter.Value; }
141    }
142    public PercentValue RelativeNumberOfEvaluatedSamples {
143      get { return RelativeNumberOfEvaluatedSamplesParameter.Value; }
144    }
145
146    public IntRange FitnessCalculationPartition {
147      get { return FitnessCalculationPartitionParameter.Value; }
148    }
149    public IntRange ValidationPartition {
150      get { return ValidationPartitionParameter.Value; }
151    }
152    public BoolValue ApplyLinearScaling {
153      get { return ApplyLinearScalingParameter.Value; }
154    }
155    #endregion
156
157    [StorableConstructor]
158    protected SymbolicDataAnalysisProblem(StorableConstructorFlag deserializing) : base(deserializing) { }
159    [StorableHook(HookType.AfterDeserialization)]
160    private void AfterDeserialization() {
161      if (!Parameters.ContainsKey(ApplyLinearScalingParameterName)) {
162        Parameters.Add(new FixedValueParameter<BoolValue>(ApplyLinearScalingParameterName, ApplyLinearScalingParameterDescription, new BoolValue(false)));
163        ApplyLinearScalingParameter.Hidden = true;
164
165        //it is assumed that for all symbolic regression algorithms linear scaling was set to true
166        //there is no possibility to determine the previous value of the parameter as it was stored in the evaluator
167        if (GetType().Name.Contains("SymbolicRegression"))
168          ApplyLinearScaling.Value = true;
169      }
170
171      RegisterEventHandlers();
172    }
173    protected SymbolicDataAnalysisProblem(SymbolicDataAnalysisProblem<T, U, V> original, Cloner cloner)
174      : base(original, cloner) {
175      RegisterEventHandlers();
176    }
177
178    protected SymbolicDataAnalysisProblem(T problemData, U evaluator, V solutionCreator)
179      : base(evaluator, solutionCreator) {
180      Parameters.Add(new ValueParameter<T>(ProblemDataParameterName, ProblemDataParameterDescription, problemData));
181      Parameters.Add(new ValueParameter<ISymbolicDataAnalysisGrammar>(SymbolicExpressionTreeGrammarParameterName, SymbolicExpressionTreeGrammarParameterDescription));
182      Parameters.Add(new ValueParameter<ISymbolicDataAnalysisExpressionTreeInterpreter>(SymbolicExpressionTreeInterpreterParameterName, SymoblicExpressionTreeInterpreterParameterDescription));
183      Parameters.Add(new FixedValueParameter<IntValue>(MaximumSymbolicExpressionTreeDepthParameterName, MaximumSymbolicExpressionTreeDepthParameterDescription));
184      Parameters.Add(new FixedValueParameter<IntValue>(MaximumSymbolicExpressionTreeLengthParameterName, MaximumSymbolicExpressionTreeLengthParameterDescription));
185      Parameters.Add(new FixedValueParameter<IntValue>(MaximumFunctionDefinitionsParameterName, MaximumFunctionDefinitionsParameterDescription));
186      Parameters.Add(new FixedValueParameter<IntValue>(MaximumFunctionArgumentsParameterName, MaximumFunctionArgumentsParameterDescription));
187      Parameters.Add(new FixedValueParameter<IntRange>(FitnessCalculationPartitionParameterName, FitnessCalculationPartitionParameterDescription));
188      Parameters.Add(new FixedValueParameter<IntRange>(ValidationPartitionParameterName, ValidationPartitionParameterDescription));
189      Parameters.Add(new FixedValueParameter<PercentValue>(RelativeNumberOfEvaluatedSamplesParameterName, RelativeNumberOfEvaluatedSamplesParameterDescription, new PercentValue(1)));
190      Parameters.Add(new FixedValueParameter<BoolValue>(ApplyLinearScalingParameterName, ApplyLinearScalingParameterDescription, new BoolValue(false)));
191
192      SymbolicExpressionTreeInterpreterParameter.Hidden = true;
193      MaximumFunctionArgumentsParameter.Hidden = true;
194      MaximumFunctionDefinitionsParameter.Hidden = true;
195      ApplyLinearScalingParameter.Hidden = true;
196
197      SymbolicExpressionTreeGrammar = new TypeCoherentExpressionGrammar();
198      SymbolicExpressionTreeInterpreter = new SymbolicDataAnalysisExpressionTreeLinearInterpreter();
199
200      FitnessCalculationPartition.Start = ProblemData.TrainingPartition.Start;
201      FitnessCalculationPartition.End = ProblemData.TrainingPartition.End;
202
203      InitializeOperators();
204
205      UpdateGrammar();
206      RegisterEventHandlers();
207    }
208
209    protected virtual void UpdateGrammar() {
210      var problemData = ProblemData;
211      var ds = problemData.Dataset;
212      var grammar = SymbolicExpressionTreeGrammar;
213      grammar.MaximumFunctionArguments = MaximumFunctionArguments.Value;
214      grammar.MaximumFunctionDefinitions = MaximumFunctionDefinitions.Value;
215      foreach (var varSymbol in grammar.Symbols.OfType<HeuristicLab.Problems.DataAnalysis.Symbolic.VariableBase>()) {
216        if (!varSymbol.Fixed) {
217          varSymbol.AllVariableNames = problemData.InputVariables.Select(x => x.Value).Where(x => ds.VariableHasType<double>(x));
218          varSymbol.VariableNames = problemData.AllowedInputVariables.Where(x => ds.VariableHasType<double>(x));
219        }
220      }
221      foreach (var factorSymbol in grammar.Symbols.OfType<BinaryFactorVariable>()) {
222        if (!factorSymbol.Fixed) {
223          factorSymbol.AllVariableNames = problemData.InputVariables.Select(x => x.Value).Where(x => ds.VariableHasType<string>(x));
224          factorSymbol.VariableNames = problemData.AllowedInputVariables.Where(x => ds.VariableHasType<string>(x));
225          factorSymbol.VariableValues = factorSymbol.VariableNames
226            .ToDictionary(varName => varName, varName => ds.GetStringValues(varName).Distinct().ToList());
227        }
228      }
229      foreach (var factorSymbol in grammar.Symbols.OfType<FactorVariable>()) {
230        if (!factorSymbol.Fixed) {
231          factorSymbol.AllVariableNames = problemData.InputVariables.Select(x => x.Value).Where(x => ds.VariableHasType<string>(x));
232          factorSymbol.VariableNames = problemData.AllowedInputVariables.Where(x => ds.VariableHasType<string>(x));
233          factorSymbol.VariableValues = factorSymbol.VariableNames
234            .ToDictionary(varName => varName,
235            varName => ds.GetStringValues(varName).Distinct()
236            .Select((n, i) => Tuple.Create(n, i))
237            .ToDictionary(tup => tup.Item1, tup => tup.Item2));
238        }
239      }
240    }
241
242    private void InitializeOperators() {
243      Operators.AddRange(ApplicationManager.Manager.GetInstances<ISymbolicExpressionTreeOperator>());
244      Operators.AddRange(ApplicationManager.Manager.GetInstances<ISymbolicDataAnalysisExpressionCrossover<T>>());
245      Operators.Add(new SymbolicExpressionSymbolFrequencyAnalyzer());
246      Operators.Add(new SymbolicDataAnalysisVariableFrequencyAnalyzer());
247      Operators.Add(new MinAverageMaxSymbolicExpressionTreeLengthAnalyzer());
248      Operators.Add(new SymbolicExpressionTreeLengthAnalyzer());
249      Operators.Add(new SymbolicExpressionTreeBottomUpSimilarityCalculator());
250      Operators.Add(new SymbolicDataAnalysisBottomUpDiversityAnalyzer(Operators.OfType<SymbolicExpressionTreeBottomUpSimilarityCalculator>().First()));
251      ParameterizeOperators();
252    }
253
254    #region events
255    private void RegisterEventHandlers() {
256      ProblemDataParameter.ValueChanged += new EventHandler(ProblemDataParameter_ValueChanged);
257      ProblemDataParameter.Value.Changed += (object sender, EventArgs e) => OnProblemDataChanged();
258
259      SymbolicExpressionTreeGrammarParameter.ValueChanged += new EventHandler(SymbolicExpressionTreeGrammarParameter_ValueChanged);
260
261      MaximumFunctionArguments.ValueChanged += new EventHandler(ArchitectureParameterValue_ValueChanged);
262      MaximumFunctionDefinitions.ValueChanged += new EventHandler(ArchitectureParameterValue_ValueChanged);
263      MaximumSymbolicExpressionTreeDepth.ValueChanged += new EventHandler(MaximumSymbolicExpressionTreeDepth_ValueChanged);
264    }
265
266    private void ProblemDataParameter_ValueChanged(object sender, EventArgs e) {
267      ValidationPartition.Start = 0;
268      ValidationPartition.End = 0;
269      ProblemDataParameter.Value.Changed += (object s, EventArgs args) => OnProblemDataChanged();
270      OnProblemDataChanged();
271    }
272
273    private void SymbolicExpressionTreeGrammarParameter_ValueChanged(object sender, EventArgs e) {
274      UpdateGrammar();
275    }
276
277    private void ArchitectureParameterValue_ValueChanged(object sender, EventArgs e) {
278      UpdateGrammar();
279    }
280
281    private void MaximumSymbolicExpressionTreeDepth_ValueChanged(object sender, EventArgs e) {
282      if (MaximumSymbolicExpressionTreeDepth != null && MaximumSymbolicExpressionTreeDepth.Value < 3)
283        MaximumSymbolicExpressionTreeDepth.Value = 3;
284    }
285
286    protected override void OnSolutionCreatorChanged() {
287      base.OnSolutionCreatorChanged();
288      SolutionCreator.SymbolicExpressionTreeParameter.ActualNameChanged += new EventHandler(SolutionCreator_SymbolicExpressionTreeParameter_ActualNameChanged);
289      ParameterizeOperators();
290    }
291
292    private void SolutionCreator_SymbolicExpressionTreeParameter_ActualNameChanged(object sender, EventArgs e) {
293      ParameterizeOperators();
294    }
295
296    protected override void OnEvaluatorChanged() {
297      base.OnEvaluatorChanged();
298      ParameterizeOperators();
299    }
300
301    public event EventHandler ProblemDataChanged;
302    protected virtual void OnProblemDataChanged() {
303      FitnessCalculationPartition.Start = ProblemData.TrainingPartition.Start;
304      FitnessCalculationPartition.End = ProblemData.TrainingPartition.End;
305
306      UpdateGrammar();
307      ParameterizeOperators();
308
309      var handler = ProblemDataChanged;
310      if (handler != null) handler(this, EventArgs.Empty);
311
312      OnReset();
313    }
314    #endregion
315
316    protected virtual void ParameterizeOperators() {
317      var operators = Parameters.OfType<IValueParameter>().Select(p => p.Value).OfType<IOperator>().Union(Operators).ToList();
318
319      foreach (var op in operators.OfType<ISymbolicExpressionTreeGrammarBasedOperator>()) {
320        op.SymbolicExpressionTreeGrammarParameter.ActualName = SymbolicExpressionTreeGrammarParameter.Name;
321      }
322      foreach (var op in operators.OfType<ISymbolicExpressionTreeSizeConstraintOperator>()) {
323        op.MaximumSymbolicExpressionTreeDepthParameter.ActualName = MaximumSymbolicExpressionTreeDepthParameter.Name;
324        op.MaximumSymbolicExpressionTreeLengthParameter.ActualName = MaximumSymbolicExpressionTreeLengthParameter.Name;
325      }
326      foreach (var op in operators.OfType<ISymbolicExpressionTreeArchitectureAlteringOperator>()) {
327        op.MaximumFunctionArgumentsParameter.ActualName = MaximumFunctionArgumentsParameter.Name;
328        op.MaximumFunctionDefinitionsParameter.ActualName = MaximumFunctionDefinitionsParameter.Name;
329      }
330      foreach (var op in operators.OfType<ISymbolicDataAnalysisEvaluator<T>>()) {
331        op.ProblemDataParameter.ActualName = ProblemDataParameterName;
332        op.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
333        op.EvaluationPartitionParameter.ActualName = FitnessCalculationPartitionParameter.Name;
334        op.RelativeNumberOfEvaluatedSamplesParameter.ActualName = RelativeNumberOfEvaluatedSamplesParameter.Name;
335        op.ApplyLinearScalingParameter.ActualName = ApplyLinearScalingParameter.Name;
336      }
337      foreach (var op in operators.OfType<ISymbolicExpressionTreeCrossover>()) {
338        op.ParentsParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
339        op.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
340      }
341      foreach (var op in operators.OfType<ISymbolicExpressionTreeManipulator>()) {
342        op.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
343      }
344      foreach (var op in operators.OfType<ISymbolicExpressionTreeAnalyzer>()) {
345        op.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
346      }
347      foreach (var op in operators.OfType<ISymbolicDataAnalysisSingleObjectiveAnalyzer>()) {
348        op.ApplyLinearScalingParameter.ActualName = ApplyLinearScalingParameter.Name;
349      }
350      foreach (var op in operators.OfType<ISymbolicDataAnalysisMultiObjectiveAnalyzer>()) {
351        op.ApplyLinearScalingParameter.ActualName = ApplyLinearScalingParameter.Name;
352      }
353      foreach (var op in operators.OfType<ISymbolicDataAnalysisAnalyzer>()) {
354        op.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
355      }
356      foreach (var op in operators.OfType<ISymbolicDataAnalysisValidationAnalyzer<U, T>>()) {
357        op.RelativeNumberOfEvaluatedSamplesParameter.ActualName = RelativeNumberOfEvaluatedSamplesParameter.Name;
358        op.ValidationPartitionParameter.ActualName = ValidationPartitionParameter.Name;
359      }
360      foreach (var op in operators.OfType<ISymbolicDataAnalysisInterpreterOperator>()) {
361        op.SymbolicDataAnalysisTreeInterpreterParameter.ActualName = SymbolicExpressionTreeInterpreterParameter.Name;
362      }
363      foreach (var op in operators.OfType<ISymbolicDataAnalysisExpressionCrossover<T>>()) {
364        op.EvaluationPartitionParameter.ActualName = FitnessCalculationPartitionParameter.Name;
365        op.ProblemDataParameter.ActualName = ProblemDataParameter.Name;
366        op.EvaluationPartitionParameter.ActualName = FitnessCalculationPartitionParameter.Name;
367        op.RelativeNumberOfEvaluatedSamplesParameter.ActualName = RelativeNumberOfEvaluatedSamplesParameter.Name;
368        op.EvaluatorParameter.ActualName = EvaluatorParameter.Name;
369      }
370    }
371
372    #region Import & Export
373    public virtual void Load(T data) {
374      Name = data.Name;
375      Description = data.Description;
376      ProblemData = data;
377    }
378
379    public virtual T Export() {
380      return ProblemData;
381    }
382    #endregion
383  }
384}
Note: See TracBrowser for help on using the repository browser.