Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Algorithms.DataAnalysis/3.4/GaussianProcess/GaussianProcessRegressionSolutionCreator.cs @ 14185

Last change on this file since 14185 was 14185, checked in by swagner, 8 years ago

#2526: Updated year of copyrights in license headers

File size: 5.9 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 HeuristicLab.Common;
23using HeuristicLab.Core;
24using HeuristicLab.Data;
25using HeuristicLab.Operators;
26using HeuristicLab.Optimization;
27using HeuristicLab.Parameters;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29using HeuristicLab.Problems.DataAnalysis;
30
31namespace HeuristicLab.Algorithms.DataAnalysis {
32  [StorableClass]
33  [Item(Name = "GaussianProcessRegressionSolutionCreator",
34    Description = "Creates a Gaussian process solution from a trained model.")]
35  public sealed class GaussianProcessRegressionSolutionCreator : SingleSuccessorOperator {
36    private const string ProblemDataParameterName = "ProblemData";
37    private const string ModelParameterName = "GaussianProcessRegressionModel";
38    private const string SolutionParameterName = "Solution";
39    private const string ResultsParameterName = "Results";
40    private const string TrainingRSquaredResultName = "Training R²";
41    private const string TestRSquaredResultName = "Test R²";
42    private const string CreateSolutionParameterName = "CreateSolution";
43
44    #region Parameter Properties
45    public ILookupParameter<IRegressionProblemData> ProblemDataParameter {
46      get { return (ILookupParameter<IRegressionProblemData>)Parameters[ProblemDataParameterName]; }
47    }
48    public ILookupParameter<IGaussianProcessSolution> SolutionParameter {
49      get { return (ILookupParameter<IGaussianProcessSolution>)Parameters[SolutionParameterName]; }
50    }
51    public ILookupParameter<IGaussianProcessModel> ModelParameter {
52      get { return (ILookupParameter<IGaussianProcessModel>)Parameters[ModelParameterName]; }
53    }
54    public ILookupParameter<ResultCollection> ResultsParameter {
55      get { return (ILookupParameter<ResultCollection>)Parameters[ResultsParameterName]; }
56    }
57    public ILookupParameter<BoolValue> CreateSolutionParameter {
58      get { return (ILookupParameter<BoolValue>)Parameters[CreateSolutionParameterName]; }
59    }
60    #endregion
61
62    [StorableConstructor]
63    private GaussianProcessRegressionSolutionCreator(bool deserializing) : base(deserializing) { }
64    private GaussianProcessRegressionSolutionCreator(GaussianProcessRegressionSolutionCreator original, Cloner cloner) : base(original, cloner) { }
65    public GaussianProcessRegressionSolutionCreator()
66      : base() {
67      // in
68      Parameters.Add(new LookupParameter<IRegressionProblemData>(ProblemDataParameterName, "The regression problem data for the Gaussian process solution."));
69      Parameters.Add(new LookupParameter<IGaussianProcessModel>(ModelParameterName, "The Gaussian process regression model to use for the solution."));
70      Parameters.Add(new LookupParameter<BoolValue>(CreateSolutionParameterName, "Flag that indicates if a solution should be produced at the end of the run"));
71
72      // in & out
73      Parameters.Add(new LookupParameter<ResultCollection>(ResultsParameterName, "The result collection of the algorithm."));
74      // out
75      Parameters.Add(new LookupParameter<IGaussianProcessSolution>(SolutionParameterName, "The produced Gaussian process solution."));
76    }
77
78    [StorableHook(HookType.AfterDeserialization)]
79    private void AfterDeserialization() {
80      // BackwardsCompatibility3.3
81      #region Backwards compatible code, remove with 3.4
82      if (!Parameters.ContainsKey(CreateSolutionParameterName)) {
83        Parameters.Add(new LookupParameter<BoolValue>(CreateSolutionParameterName, "Flag that indicates if a solution should be produced at the end of the run"));
84      }
85      #endregion
86    }
87
88    public override IDeepCloneable Clone(Cloner cloner) {
89      return new GaussianProcessRegressionSolutionCreator(this, cloner);
90    }
91
92    public override IOperation Apply() {
93      if (ModelParameter.ActualValue != null && CreateSolutionParameter.ActualValue.Value == true) {
94        var m = (IGaussianProcessModel)ModelParameter.ActualValue.Clone();
95        m.FixParameters();
96        var data = (IRegressionProblemData)ProblemDataParameter.ActualValue.Clone();
97        var s = new GaussianProcessRegressionSolution(m, data);
98
99
100        SolutionParameter.ActualValue = s;
101        var results = ResultsParameter.ActualValue;
102        if (!results.ContainsKey(SolutionParameterName)) {
103          results.Add(new Result(SolutionParameterName, "The Gaussian process regression solution", s));
104          results.Add(new Result(TrainingRSquaredResultName,
105                                 "The Pearson's R² of the Gaussian process solution on the training partition.",
106                                 new DoubleValue(s.TrainingRSquared)));
107          results.Add(new Result(TestRSquaredResultName,
108                                 "The Pearson's R² of the Gaussian process solution on the test partition.",
109                                 new DoubleValue(s.TestRSquared)));
110        } else {
111          results[SolutionParameterName].Value = s;
112          results[TrainingRSquaredResultName].Value = new DoubleValue(s.TrainingRSquared);
113          results[TestRSquaredResultName].Value = new DoubleValue(s.TestRSquared);
114        }
115      }
116      return base.Apply();
117    }
118  }
119}
Note: See TracBrowser for help on using the repository browser.