Free cookie consent management tool by TermsFeed Policy Generator

source: branches/GP.Symbols (TimeLag, Diff, Integral)/HeuristicLab.Problems.DataAnalysis.Regression/3.3/Symbolic/SymbolicRegressionProblemBase.cs @ 7532

Last change on this file since 7532 was 5060, checked in by mkommend, 14 years ago

Implemented VariableCondition symbol (ticket #1325).
File size: 19.2 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;
23using System.Collections.Generic;
24using System.Linq;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Data;
28using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding;
29using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding.Analyzers;
30using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding.Creators;
31using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding.Interfaces;
32using HeuristicLab.Optimization;
33using HeuristicLab.Parameters;
34using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
35using HeuristicLab.PluginInfrastructure;
36using HeuristicLab.Problems.DataAnalysis.Regression.Symbolic.Analyzers;
37using HeuristicLab.Problems.DataAnalysis.Symbolic;
38
39namespace HeuristicLab.Problems.DataAnalysis.Regression.Symbolic {
40  [StorableClass]
41  public abstract class SymbolicRegressionProblemBase : DataAnalysisProblem, IProblem {
42
43    #region Parameter Properties
44    public new ValueParameter<SymbolicExpressionTreeCreator> SolutionCreatorParameter {
45      get { return (ValueParameter<SymbolicExpressionTreeCreator>)Parameters["SolutionCreator"]; }
46    }
47    IParameter IProblem.SolutionCreatorParameter {
48      get { return SolutionCreatorParameter; }
49    }
50    public ValueParameter<DoubleValue> LowerEstimationLimitParameter {
51      get { return (ValueParameter<DoubleValue>)Parameters["LowerEstimationLimit"]; }
52    }
53    public ValueParameter<DoubleValue> UpperEstimationLimitParameter {
54      get { return (ValueParameter<DoubleValue>)Parameters["UpperEstimationLimit"]; }
55    }
56    public ValueParameter<ISymbolicExpressionTreeInterpreter> SymbolicExpressionTreeInterpreterParameter {
57      get { return (ValueParameter<ISymbolicExpressionTreeInterpreter>)Parameters["SymbolicExpressionTreeInterpreter"]; }
58    }
59    public ValueParameter<ISymbolicExpressionGrammar> FunctionTreeGrammarParameter {
60      get { return (ValueParameter<ISymbolicExpressionGrammar>)Parameters["FunctionTreeGrammar"]; }
61    }
62    public ValueParameter<IntValue> MaxExpressionLengthParameter {
63      get { return (ValueParameter<IntValue>)Parameters["MaxExpressionLength"]; }
64    }
65    public ValueParameter<IntValue> MaxExpressionDepthParameter {
66      get { return (ValueParameter<IntValue>)Parameters["MaxExpressionDepth"]; }
67    }
68    public ValueParameter<IntValue> MaxFunctionDefiningBranchesParameter {
69      get { return (ValueParameter<IntValue>)Parameters["MaxFunctionDefiningBranches"]; }
70    }
71    public ValueParameter<IntValue> MaxFunctionArgumentsParameter {
72      get { return (ValueParameter<IntValue>)Parameters["MaxFunctionArguments"]; }
73    }
74    #endregion
75
76    #region Properties
77    public IntValue MaxExpressionLength {
78      get { return MaxExpressionLengthParameter.Value; }
79      set { MaxExpressionLengthParameter.Value = value; }
80    }
81    public IntValue MaxExpressionDepth {
82      get { return MaxExpressionDepthParameter.Value; }
83      set { MaxExpressionDepthParameter.Value = value; }
84    }
85    public IntValue MaxFunctionDefiningBranches {
86      get { return MaxFunctionDefiningBranchesParameter.Value; }
87      set { MaxFunctionDefiningBranchesParameter.Value = value; }
88    }
89    public IntValue MaxFunctionArguments {
90      get { return MaxFunctionArgumentsParameter.Value; }
91      set { MaxFunctionArgumentsParameter.Value = value; }
92    }
93    public new SymbolicExpressionTreeCreator SolutionCreator {
94      get { return SolutionCreatorParameter.Value; }
95      set { SolutionCreatorParameter.Value = value; }
96    }
97    ISolutionCreator IProblem.SolutionCreator {
98      get { return SolutionCreatorParameter.Value; }
99    }
100    public ISymbolicExpressionTreeInterpreter SymbolicExpressionTreeInterpreter {
101      get { return SymbolicExpressionTreeInterpreterParameter.Value; }
102      set { SymbolicExpressionTreeInterpreterParameter.Value = value; }
103    }
104    public DoubleValue LowerEstimationLimit {
105      get { return LowerEstimationLimitParameter.Value; }
106      set { LowerEstimationLimitParameter.Value = value; }
107    }
108    public DoubleValue UpperEstimationLimit {
109      get { return UpperEstimationLimitParameter.Value; }
110      set { UpperEstimationLimitParameter.Value = value; }
111    }
112
113    public ISymbolicExpressionGrammar FunctionTreeGrammar {
114      get { return (ISymbolicExpressionGrammar)FunctionTreeGrammarParameter.Value; }
115      private set { FunctionTreeGrammarParameter.Value = value; }
116    }
117    public override IEnumerable<IOperator> Operators {
118      get { return operators; }
119    }
120    public IEnumerable<ISymbolicRegressionAnalyzer> Analyzers {
121      get { return operators.OfType<ISymbolicRegressionAnalyzer>(); }
122    }
123    public DoubleValue PunishmentFactor {
124      get { return new DoubleValue(10.0); }
125    }
126    public IntValue TrainingSamplesStart {
127      get { return new IntValue(DataAnalysisProblemData.TrainingIndizes.First()); }
128    }
129    public IntValue TrainingSamplesEnd {
130      get {
131        int endIndex = (int)(DataAnalysisProblemData.TrainingIndizes.Count() * (1.0 - DataAnalysisProblemData.ValidationPercentage.Value) - 1);
132        if (endIndex < 0) endIndex = 0;
133        return new IntValue(DataAnalysisProblemData.TrainingIndizes.ElementAt(endIndex));
134      }
135    }
136    public IntValue ValidationSamplesStart {
137      get { return TrainingSamplesEnd; }
138    }
139    public IntValue ValidationSamplesEnd {
140      get { return new IntValue(DataAnalysisProblemData.TrainingIndizes.Last() + 1); }
141    }
142    public IntValue TestSamplesStart {
143      get { return DataAnalysisProblemData.TestSamplesStart; }
144    }
145    public IntValue TestSamplesEnd {
146      get { return DataAnalysisProblemData.TestSamplesEnd; }
147    }
148    #endregion
149
150    [Storable]
151    private List<IOperator> operators;
152
153    [StorableConstructor]
154    protected SymbolicRegressionProblemBase(bool deserializing) : base(deserializing) { }
155    protected SymbolicRegressionProblemBase(SymbolicRegressionProblemBase original, Cloner cloner)
156      : base(original, cloner) {
157      operators = original.operators.Select(x => (IOperator)cloner.Clone(x)).ToList();
158      RegisterParameterValueEvents();
159      RegisterParameterEvents();
160    }
161    public SymbolicRegressionProblemBase()
162      : base() {
163      SymbolicExpressionTreeCreator creator = new ProbabilisticTreeCreator();
164      var grammar = new FullFunctionalExpressionGrammar();
165      var globalGrammar = new GlobalSymbolicExpressionGrammar(grammar);
166      var interpreter = new SimpleArithmeticExpressionInterpreter();
167      Parameters.Add(new ValueParameter<SymbolicExpressionTreeCreator>("SolutionCreator", "The operator which should be used to create new symbolic regression solutions.", creator));
168      Parameters.Add(new ValueParameter<ISymbolicExpressionTreeInterpreter>("SymbolicExpressionTreeInterpreter", "The interpreter that should be used to evaluate the symbolic expression tree.", interpreter));
169      Parameters.Add(new ValueParameter<DoubleValue>("LowerEstimationLimit", "The lower limit for the estimated value that can be returned by the symbolic regression model.", new DoubleValue(double.NegativeInfinity)));
170      Parameters.Add(new ValueParameter<DoubleValue>("UpperEstimationLimit", "The upper limit for the estimated value that can be returned by the symbolic regression model.", new DoubleValue(double.PositiveInfinity)));
171      Parameters.Add(new ValueParameter<ISymbolicExpressionGrammar>("FunctionTreeGrammar", "The grammar that should be used for symbolic regression models.", globalGrammar));
172      Parameters.Add(new ValueParameter<IntValue>("MaxExpressionLength", "Maximal length of the symbolic expression.", new IntValue(100)));
173      Parameters.Add(new ValueParameter<IntValue>("MaxExpressionDepth", "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.", new IntValue(10)));
174      Parameters.Add(new ValueParameter<IntValue>("MaxFunctionDefiningBranches", "Maximal number of automatically defined functions.", (IntValue)new IntValue(0).AsReadOnly()));
175      Parameters.Add(new ValueParameter<IntValue>("MaxFunctionArguments", "Maximal number of arguments of automatically defined functions.", (IntValue)new IntValue(0).AsReadOnly()));
176
177      creator.SymbolicExpressionTreeParameter.ActualName = "SymbolicRegressionModel";
178
179      ParameterizeSolutionCreator();
180
181      UpdateGrammar();
182      UpdateEstimationLimits();
183      InitializeOperators();
184      RegisterParameterValueEvents();
185      RegisterParameterEvents();
186    }
187
188    private void RegisterParameterEvents() {
189      MaxFunctionArgumentsParameter.ValueChanged += new EventHandler(ArchitectureParameter_ValueChanged);
190      MaxFunctionDefiningBranchesParameter.ValueChanged += new EventHandler(ArchitectureParameter_ValueChanged);
191      MaxExpressionDepthParameter.ValueChanged += new EventHandler(MaxExpressionDepthParameter_ValueChanged);
192      SolutionCreatorParameter.ValueChanged += new EventHandler(SolutionCreatorParameter_ValueChanged);
193      FunctionTreeGrammarParameter.ValueChanged += new EventHandler(FunctionTreeGrammarParameter_ValueChanged);
194      SolutionCreator.SymbolicExpressionTreeParameter.ActualNameChanged += new EventHandler(SolutionCreator_SymbolicExpressionTreeParameter_ActualNameChanged);
195    }
196
197    private void RegisterParameterValueEvents() {
198      MaxFunctionArgumentsParameter.Value.ValueChanged += new EventHandler(ArchitectureParameterValue_ValueChanged);
199      MaxFunctionDefiningBranchesParameter.Value.ValueChanged += new EventHandler(ArchitectureParameterValue_ValueChanged);
200      MaxExpressionDepthParameter.Value.ValueChanged += new EventHandler(MaxExpressionDepthParameterValue_ValueChanged);
201    }
202
203    #region event handling
204    protected override void OnDataAnalysisProblemChanged(EventArgs e) {
205      base.OnDataAnalysisProblemChanged(e);
206      // paritions could be changed
207      ParameterizeAnalyzers();
208      // input variables could have been changed
209      UpdateGrammar();
210      // estimation limits have to be recalculated
211      UpdateEstimationLimits();
212    }
213    protected virtual void OnArchitectureParameterChanged(EventArgs e) {
214      UpdateGrammar();
215    }
216    protected virtual void OnGrammarChanged() { UpdateGrammar(); }
217    protected virtual void OnOperatorsChanged(EventArgs e) { RaiseOperatorsChanged(e); }
218    protected virtual void OnSolutionCreatorChanged(EventArgs e) {
219      SolutionCreator.SymbolicExpressionTreeParameter.ActualNameChanged += new EventHandler(SolutionCreator_SymbolicExpressionTreeParameter_ActualNameChanged);
220      ParameterizeSolutionCreator();
221      OnSolutionParameterNameChanged(e);
222      RaiseSolutionCreatorChanged(e);
223    }
224
225    protected virtual void OnSolutionParameterNameChanged(EventArgs e) {
226      ParameterizeAnalyzers();
227      ParameterizeOperators();
228    }
229
230    protected virtual void OnEvaluatorChanged(EventArgs e) {
231      RaiseEvaluatorChanged(e);
232    }
233    #endregion
234
235    #region event handlers
236    private void FunctionTreeGrammarParameter_ValueChanged(object sender, EventArgs e) {
237      if (!(FunctionTreeGrammar is GlobalSymbolicExpressionGrammar))
238        FunctionTreeGrammar = new GlobalSymbolicExpressionGrammar(FunctionTreeGrammar);
239      OnGrammarChanged();
240    }
241
242    private void SolutionCreatorParameter_ValueChanged(object sender, EventArgs e) {
243      OnSolutionCreatorChanged(e);
244    }
245    private void SolutionCreator_SymbolicExpressionTreeParameter_ActualNameChanged(object sender, EventArgs e) {
246      OnSolutionParameterNameChanged(e);
247    }
248    private void ArchitectureParameter_ValueChanged(object sender, EventArgs e) {
249      MaxFunctionArgumentsParameter.Value.ValueChanged += new EventHandler(ArchitectureParameterValue_ValueChanged);
250      MaxFunctionDefiningBranchesParameter.Value.ValueChanged += new EventHandler(ArchitectureParameterValue_ValueChanged);
251      OnArchitectureParameterChanged(e);
252    }
253    private void ArchitectureParameterValue_ValueChanged(object sender, EventArgs e) {
254      OnArchitectureParameterChanged(e);
255    }
256
257    private void MaxExpressionDepthParameter_ValueChanged(object sender, EventArgs e) {
258      MaxExpressionDepthParameterValue_ValueChanged(sender, e);
259      MaxExpressionDepthParameter.Value.ValueChanged += MaxExpressionDepthParameterValue_ValueChanged;
260    }
261    private void MaxExpressionDepthParameterValue_ValueChanged(object sender, EventArgs e) {
262      if (MaxExpressionDepth != null && MaxExpressionDepth.Value < 3)
263        MaxExpressionDepth.Value = 3;
264    }
265    #endregion
266
267    #region Helpers
268    [StorableHook(HookType.AfterDeserialization)]
269    private void AfterDeserializationHook() {
270      // BackwardsCompatibility3.3
271      #region Backwards compatible code (remove with 3.4)
272      if (operators == null) InitializeOperators();
273      #endregion
274      RegisterParameterValueEvents();
275      RegisterParameterEvents();
276    }
277
278    protected void AddOperator(IOperator op) {
279      operators.Add(op);
280    }
281
282    private void UpdateGrammar() {
283      foreach (var varSymbol in FunctionTreeGrammar.Symbols.OfType<HeuristicLab.Problems.DataAnalysis.Symbolic.Symbols.Variable>()) {
284        varSymbol.VariableNames = DataAnalysisProblemData.InputVariables.CheckedItems.Select(x => x.Value.Value);
285      }
286      foreach (var varSymbol in FunctionTreeGrammar.Symbols.OfType<HeuristicLab.Problems.DataAnalysis.Symbolic.Symbols.VariableCondition>()) {
287        varSymbol.VariableNames = DataAnalysisProblemData.InputVariables.CheckedItems.Select(x => x.Value.Value);
288      }
289      var globalGrammar = FunctionTreeGrammar as GlobalSymbolicExpressionGrammar;
290      if (globalGrammar != null) {
291        globalGrammar.MaxFunctionArguments = MaxFunctionArguments.Value;
292        globalGrammar.MaxFunctionDefinitions = MaxFunctionDefiningBranches.Value;
293      }
294    }
295
296    private void UpdateEstimationLimits() {
297      if (TrainingSamplesStart.Value < TrainingSamplesEnd.Value &&
298        DataAnalysisProblemData.Dataset.VariableNames.Contains(DataAnalysisProblemData.TargetVariable.Value)) {
299        var targetValues = DataAnalysisProblemData.Dataset.GetVariableValues(DataAnalysisProblemData.TargetVariable.Value, TrainingSamplesStart.Value, TrainingSamplesEnd.Value);
300        var mean = targetValues.Average();
301        var range = targetValues.Max() - targetValues.Min();
302        UpperEstimationLimit = new DoubleValue(mean + PunishmentFactor.Value * range);
303        LowerEstimationLimit = new DoubleValue(mean - PunishmentFactor.Value * range);
304      }
305    }
306
307    private void InitializeOperators() {
308      operators = new List<IOperator>();
309      operators.AddRange(ApplicationManager.Manager.GetInstances<ISymbolicExpressionTreeOperator>().OfType<IOperator>());
310      operators.Add(new SymbolicRegressionVariableFrequencyAnalyzer());
311      operators.Add(new MinAverageMaxSymbolicExpressionTreeSizeAnalyzer());
312      operators.Add(new SymbolicRegressionModelQualityAnalyzer());
313      ParameterizeOperators();
314      ParameterizeAnalyzers();
315    }
316
317    private void ParameterizeSolutionCreator() {
318      SolutionCreator.SymbolicExpressionGrammarParameter.ActualName = FunctionTreeGrammarParameter.Name;
319      SolutionCreator.MaxTreeHeightParameter.ActualName = MaxExpressionDepthParameter.Name;
320      SolutionCreator.MaxTreeSizeParameter.ActualName = MaxExpressionLengthParameter.Name;
321      SolutionCreator.MaxFunctionArgumentsParameter.ActualName = MaxFunctionArgumentsParameter.Name;
322      SolutionCreator.MaxFunctionDefinitionsParameter.ActualName = MaxFunctionDefiningBranchesParameter.Name;
323    }
324
325    private void ParameterizeAnalyzers() {
326      foreach (var analyzer in Analyzers) {
327        analyzer.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
328        var symbolicRegressionModelQualityAnalyzer = analyzer as SymbolicRegressionModelQualityAnalyzer;
329        if (symbolicRegressionModelQualityAnalyzer != null) {
330          symbolicRegressionModelQualityAnalyzer.ProblemDataParameter.ActualName = DataAnalysisProblemDataParameter.Name;
331          symbolicRegressionModelQualityAnalyzer.UpperEstimationLimitParameter.ActualName = UpperEstimationLimitParameter.Name;
332          symbolicRegressionModelQualityAnalyzer.LowerEstimationLimitParameter.ActualName = LowerEstimationLimitParameter.Name;
333          symbolicRegressionModelQualityAnalyzer.SymbolicExpressionTreeInterpreterParameter.ActualName = SymbolicExpressionTreeInterpreterParameter.Name;
334          symbolicRegressionModelQualityAnalyzer.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
335        }
336        var varFreqAnalyzer = analyzer as SymbolicRegressionVariableFrequencyAnalyzer;
337        if (varFreqAnalyzer != null) {
338          varFreqAnalyzer.ProblemDataParameter.ActualName = DataAnalysisProblemDataParameter.Name;
339        }
340      }
341      foreach (ISymbolicExpressionTreeAnalyzer analyzer in Operators.OfType<ISymbolicExpressionTreeAnalyzer>()) {
342        analyzer.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
343      }
344    }
345
346    private void ParameterizeOperators() {
347      foreach (ISymbolicExpressionTreeOperator op in Operators.OfType<ISymbolicExpressionTreeOperator>()) {
348        op.MaxTreeHeightParameter.ActualName = MaxExpressionDepthParameter.Name;
349        op.MaxTreeSizeParameter.ActualName = MaxExpressionLengthParameter.Name;
350        op.SymbolicExpressionGrammarParameter.ActualName = FunctionTreeGrammarParameter.Name;
351      }
352      foreach (ISymbolicExpressionTreeCrossover op in Operators.OfType<ISymbolicExpressionTreeCrossover>()) {
353        op.ParentsParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
354        op.ChildParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
355      }
356      foreach (ISymbolicExpressionTreeManipulator op in Operators.OfType<ISymbolicExpressionTreeManipulator>()) {
357        op.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
358      }
359      foreach (ISymbolicExpressionTreeArchitectureManipulator op in Operators.OfType<ISymbolicExpressionTreeArchitectureManipulator>()) {
360        op.MaxFunctionArgumentsParameter.ActualName = MaxFunctionArgumentsParameter.Name;
361        op.MaxFunctionDefinitionsParameter.ActualName = MaxFunctionDefiningBranchesParameter.Name;
362      }
363    }
364    #endregion
365  }
366}
Note: See TracBrowser for help on using the repository browser.