Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Problems.DataAnalysis.Regression/3.3/Symbolic/SymbolicRegressionProblemBase.cs @ 4681

Last change on this file since 4681 was 4486, checked in by mkommend, 14 years ago

Reorganized unit tests for more plugins into own project (ticket #1202).
File size: 19.0 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    public SymbolicRegressionProblemBase()
156      : base() {
157      SymbolicExpressionTreeCreator creator = new ProbabilisticTreeCreator();
158      var grammar = new FullFunctionalExpressionGrammar();
159      var globalGrammar = new GlobalSymbolicExpressionGrammar(grammar);
160      var interpreter = new SimpleArithmeticExpressionInterpreter();
161      Parameters.Add(new ValueParameter<SymbolicExpressionTreeCreator>("SolutionCreator", "The operator which should be used to create new symbolic regression solutions.", creator));
162      Parameters.Add(new ValueParameter<ISymbolicExpressionTreeInterpreter>("SymbolicExpressionTreeInterpreter", "The interpreter that should be used to evaluate the symbolic expression tree.", interpreter));
163      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)));
164      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)));
165      Parameters.Add(new ValueParameter<ISymbolicExpressionGrammar>("FunctionTreeGrammar", "The grammar that should be used for symbolic regression models.", globalGrammar));
166      Parameters.Add(new ValueParameter<IntValue>("MaxExpressionLength", "Maximal length of the symbolic expression.", new IntValue(100)));
167      Parameters.Add(new ValueParameter<IntValue>("MaxExpressionDepth", "Maximal depth of the symbolic expression.", new IntValue(10)));
168      Parameters.Add(new ValueParameter<IntValue>("MaxFunctionDefiningBranches", "Maximal number of automatically defined functions.", (IntValue)new IntValue(0).AsReadOnly()));
169      Parameters.Add(new ValueParameter<IntValue>("MaxFunctionArguments", "Maximal number of arguments of automatically defined functions.", (IntValue)new IntValue(0).AsReadOnly()));
170
171      creator.SymbolicExpressionTreeParameter.ActualName = "SymbolicRegressionModel";
172
173      ParameterizeSolutionCreator();
174
175      UpdateGrammar();
176      UpdateEstimationLimits();
177      InitializeOperators();
178      RegisterParameterEvents();
179      RegisterParameterValueEvents();
180    }
181
182    public override IDeepCloneable Clone(Cloner cloner) {
183      SymbolicRegressionProblemBase clone = (SymbolicRegressionProblemBase)base.Clone(cloner);
184      clone.operators = operators.Select(x => (IOperator)cloner.Clone(x)).ToList();
185      clone.RegisterParameterEvents();
186      clone.RegisterParameterValueEvents();
187      return clone;
188    }
189
190    private void RegisterParameterValueEvents() {
191      MaxFunctionArgumentsParameter.ValueChanged += new EventHandler(ArchitectureParameter_ValueChanged);
192      MaxFunctionDefiningBranchesParameter.ValueChanged += new EventHandler(ArchitectureParameter_ValueChanged);
193      SolutionCreatorParameter.ValueChanged += new EventHandler(SolutionCreatorParameter_ValueChanged);
194      FunctionTreeGrammarParameter.ValueChanged += new EventHandler(FunctionTreeGrammarParameter_ValueChanged);
195    }
196
197    private void RegisterParameterEvents() {
198      MaxFunctionArgumentsParameter.Value.ValueChanged += new EventHandler(ArchitectureParameterValue_ValueChanged);
199      MaxFunctionDefiningBranchesParameter.Value.ValueChanged += new EventHandler(ArchitectureParameterValue_ValueChanged);
200      SolutionCreator.SymbolicExpressionTreeParameter.ActualNameChanged += new EventHandler(SolutionCreator_SymbolicExpressionTreeParameter_ActualNameChanged);
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    #endregion
257
258    #region Helpers
259    [StorableHook(HookType.AfterDeserialization)]
260    private void AfterDeserializationHook() {
261      // BackwardsCompatibility3.3
262      #region Backwards compatible code (remove with 3.4)
263      if (operators == null) InitializeOperators();
264      #endregion
265      RegisterParameterEvents();
266      RegisterParameterValueEvents();
267    }
268
269    protected void AddOperator(IOperator op) {
270      operators.Add(op);
271    }
272
273    private void UpdateGrammar() {
274      foreach (var varSymbol in FunctionTreeGrammar.Symbols.OfType<HeuristicLab.Problems.DataAnalysis.Symbolic.Symbols.Variable>()) {
275        varSymbol.VariableNames = DataAnalysisProblemData.InputVariables.CheckedItems.Select(x => x.Value.Value);
276      }
277      var globalGrammar = FunctionTreeGrammar as GlobalSymbolicExpressionGrammar;
278      if (globalGrammar != null) {
279        globalGrammar.MaxFunctionArguments = MaxFunctionArguments.Value;
280        globalGrammar.MaxFunctionDefinitions = MaxFunctionDefiningBranches.Value;
281      }
282    }
283
284    private void UpdateEstimationLimits() {
285      if (TrainingSamplesStart.Value < TrainingSamplesEnd.Value &&
286        DataAnalysisProblemData.Dataset.VariableNames.Contains(DataAnalysisProblemData.TargetVariable.Value)) {
287        var targetValues = DataAnalysisProblemData.Dataset.GetVariableValues(DataAnalysisProblemData.TargetVariable.Value, TrainingSamplesStart.Value, TrainingSamplesEnd.Value);
288        var mean = targetValues.Average();
289        var range = targetValues.Max() - targetValues.Min();
290        UpperEstimationLimit = new DoubleValue(mean + PunishmentFactor.Value * range);
291        LowerEstimationLimit = new DoubleValue(mean - PunishmentFactor.Value * range);
292      }
293    }
294
295    private void InitializeOperators() {
296      operators = new List<IOperator>();
297      operators.AddRange(ApplicationManager.Manager.GetInstances<ISymbolicExpressionTreeOperator>().OfType<IOperator>());
298      operators.Add(new SymbolicRegressionVariableFrequencyAnalyzer());
299      operators.Add(new MinAverageMaxSymbolicExpressionTreeSizeAnalyzer());
300      operators.Add(new SymbolicRegressionModelQualityAnalyzer());
301      ParameterizeOperators();
302      ParameterizeAnalyzers();
303    }
304
305    private void ParameterizeSolutionCreator() {
306      SolutionCreator.SymbolicExpressionGrammarParameter.ActualName = FunctionTreeGrammarParameter.Name;
307      SolutionCreator.MaxTreeHeightParameter.ActualName = MaxExpressionDepthParameter.Name;
308      SolutionCreator.MaxTreeSizeParameter.ActualName = MaxExpressionLengthParameter.Name;
309      SolutionCreator.MaxFunctionArgumentsParameter.ActualName = MaxFunctionArgumentsParameter.Name;
310      SolutionCreator.MaxFunctionDefinitionsParameter.ActualName = MaxFunctionDefiningBranchesParameter.Name;
311    }
312
313    private void ParameterizeAnalyzers() {
314      foreach (var analyzer in Analyzers) {
315        analyzer.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
316        var symbolicRegressionModelQualityAnalyzer = analyzer as SymbolicRegressionModelQualityAnalyzer;
317        if (symbolicRegressionModelQualityAnalyzer != null) {
318          symbolicRegressionModelQualityAnalyzer.ProblemDataParameter.ActualName = DataAnalysisProblemDataParameter.Name;
319          symbolicRegressionModelQualityAnalyzer.UpperEstimationLimitParameter.ActualName = UpperEstimationLimitParameter.Name;
320          symbolicRegressionModelQualityAnalyzer.LowerEstimationLimitParameter.ActualName = LowerEstimationLimitParameter.Name;
321          symbolicRegressionModelQualityAnalyzer.SymbolicExpressionTreeInterpreterParameter.ActualName = SymbolicExpressionTreeInterpreterParameter.Name;
322          symbolicRegressionModelQualityAnalyzer.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
323        }
324        var varFreqAnalyzer = analyzer as SymbolicRegressionVariableFrequencyAnalyzer;
325        if (varFreqAnalyzer != null) {
326          varFreqAnalyzer.ProblemDataParameter.ActualName = DataAnalysisProblemDataParameter.Name;
327        }
328        var pruningOperator = analyzer as SymbolicRegressionTournamentPruning;
329        if (pruningOperator != null) {
330          pruningOperator.SamplesStartParameter.Value = TrainingSamplesStart;
331          pruningOperator.SamplesEndParameter.Value = TrainingSamplesEnd;
332          pruningOperator.DataAnalysisProblemDataParameter.ActualName = DataAnalysisProblemDataParameter.Name;
333          pruningOperator.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
334          pruningOperator.SymbolicExpressionTreeInterpreterParameter.ActualName = SymbolicExpressionTreeInterpreterParameter.Name;
335          pruningOperator.LowerEstimationLimitParameter.ActualName = LowerEstimationLimitParameter.Name;
336          pruningOperator.UpperEstimationLimitParameter.ActualName = UpperEstimationLimitParameter.Name;
337        }
338      }
339      foreach (ISymbolicExpressionTreeAnalyzer analyzer in Operators.OfType<ISymbolicExpressionTreeAnalyzer>()) {
340        analyzer.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
341      }
342    }
343
344    private void ParameterizeOperators() {
345      foreach (ISymbolicExpressionTreeOperator op in Operators.OfType<ISymbolicExpressionTreeOperator>()) {
346        op.MaxTreeHeightParameter.ActualName = MaxExpressionDepthParameter.Name;
347        op.MaxTreeSizeParameter.ActualName = MaxExpressionLengthParameter.Name;
348        op.SymbolicExpressionGrammarParameter.ActualName = FunctionTreeGrammarParameter.Name;
349      }
350      foreach (ISymbolicExpressionTreeCrossover op in Operators.OfType<ISymbolicExpressionTreeCrossover>()) {
351        op.ParentsParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
352        op.ChildParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
353      }
354      foreach (ISymbolicExpressionTreeManipulator op in Operators.OfType<ISymbolicExpressionTreeManipulator>()) {
355        op.SymbolicExpressionTreeParameter.ActualName = SolutionCreator.SymbolicExpressionTreeParameter.ActualName;
356      }
357      foreach (ISymbolicExpressionTreeArchitectureManipulator op in Operators.OfType<ISymbolicExpressionTreeArchitectureManipulator>()) {
358        op.MaxFunctionArgumentsParameter.ActualName = MaxFunctionArgumentsParameter.Name;
359        op.MaxFunctionDefinitionsParameter.ActualName = MaxFunctionDefiningBranchesParameter.Name;
360      }
361    }
362    #endregion
363  }
364}
Note: See TracBrowser for help on using the repository browser.