Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/HeuristicLab.Problems.DataAnalysis/3.4/Implementation/Classification/ClassificationModel.cs @ 16243

Last change on this file since 16243 was 16243, checked in by mkommend, 4 years ago

#2955: Added IsProblemDataCompatible and IsDatasetCompatible to all DataAnalysisModels.

File size: 4.6 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 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 HeuristicLab.Common;
25using HeuristicLab.Core;
26using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
27
28namespace HeuristicLab.Problems.DataAnalysis {
29  [StorableClass]
30  [Item("Classification Model", "Base class for all classification models.")]
31  public abstract class ClassificationModel : DataAnalysisModel, IClassificationModel {
32    [Storable]
33    private string targetVariable;
34    public string TargetVariable {
35      get { return targetVariable; }
36      set {
37        if (string.IsNullOrEmpty(value) || targetVariable == value) return;
38        targetVariable = value;
39        OnTargetVariableChanged(this, EventArgs.Empty);
40      }
41    }
42
43    protected ClassificationModel(bool deserializing)
44      : base(deserializing) {
45      targetVariable = string.Empty;
46    }
47    protected ClassificationModel(ClassificationModel original, Cloner cloner)
48      : base(original, cloner) {
49      this.targetVariable = original.targetVariable;
50    }
51
52    protected ClassificationModel(string targetVariable)
53      : base("Classification Model") {
54      this.targetVariable = targetVariable;
55    }
56    protected ClassificationModel(string targetVariable, string name)
57      : base(name) {
58      this.targetVariable = targetVariable;
59    }
60    protected ClassificationModel(string targetVariable, string name, string description)
61      : base(name, description) {
62      this.targetVariable = targetVariable;
63    }
64
65    public abstract IEnumerable<double> GetEstimatedClassValues(IDataset dataset, IEnumerable<int> rows);
66    public abstract IClassificationSolution CreateClassificationSolution(IClassificationProblemData problemData);
67
68    public virtual bool IsProblemDataCompatible(IClassificationProblemData problemData, out string errorMessage) {
69      return IsProblemDataCompatible(this, problemData, out errorMessage);
70    }
71
72    public override bool IsProblemDataCompatible(IDataAnalysisProblemData problemData, out string errorMessage) {
73      if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
74      var classificationProblemData = problemData as IClassificationProblemData;
75      if (classificationProblemData == null)
76        throw new ArgumentException("The problem data is not a regression problem data. Instead a " + problemData.GetType().GetPrettyName() + " was provided.", "problemData");
77      return IsProblemDataCompatible(classificationProblemData, out errorMessage);
78    }
79
80    public static bool IsProblemDataCompatible(IClassificationModel model, IClassificationProblemData problemData, out string errorMessage) {
81      if (model == null) throw new ArgumentNullException("model", "The provided model is null.");
82      if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
83      errorMessage = string.Empty;
84
85      if (model.TargetVariable != problemData.TargetVariable)
86        errorMessage = string.Format("The target variable of the model {0} does not match the target variable of the problemData {1}.", model.TargetVariable, problemData.TargetVariable);
87
88      var evaluationErrorMessage = string.Empty;
89      var datasetCompatible = model.IsDatasetCompatible(problemData.Dataset, out evaluationErrorMessage);
90      if (!datasetCompatible)
91        errorMessage += evaluationErrorMessage;
92
93      return string.IsNullOrEmpty(errorMessage);
94    }
95
96    #region events
97    public event EventHandler TargetVariableChanged;
98    private void OnTargetVariableChanged(object sender, EventArgs args) {
99      var changed = TargetVariableChanged;
100      if (changed != null)
101        changed(sender, args);
102    }
103    #endregion
104  }
105}
Note: See TracBrowser for help on using the repository browser.