1 | #region License Information
|
---|
2 | /* HeuristicLab
|
---|
3 | * Copyright (C) 2002-2019 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 |
|
---|
22 | using System;
|
---|
23 | using System.Collections.Generic;
|
---|
24 | using HeuristicLab.Common;
|
---|
25 | using HeuristicLab.Core;
|
---|
26 | using HEAL.Fossil;
|
---|
27 |
|
---|
28 | namespace HeuristicLab.Problems.DataAnalysis {
|
---|
29 | [StorableType("7E6091F9-86FD-4C47-8935-9C35CAB4261B")]
|
---|
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 | [StorableConstructor]
|
---|
44 | protected ClassificationModel(StorableConstructorFlag _)
|
---|
45 | : base(_) {
|
---|
46 | targetVariable = string.Empty;
|
---|
47 | }
|
---|
48 | protected ClassificationModel(ClassificationModel original, Cloner cloner)
|
---|
49 | : base(original, cloner) {
|
---|
50 | this.targetVariable = original.targetVariable;
|
---|
51 | }
|
---|
52 |
|
---|
53 | protected ClassificationModel(string targetVariable)
|
---|
54 | : base("Classification Model") {
|
---|
55 | this.targetVariable = targetVariable;
|
---|
56 | }
|
---|
57 | protected ClassificationModel(string targetVariable, string name)
|
---|
58 | : base(name) {
|
---|
59 | this.targetVariable = targetVariable;
|
---|
60 | }
|
---|
61 | protected ClassificationModel(string targetVariable, string name, string description)
|
---|
62 | : base(name, description) {
|
---|
63 | this.targetVariable = targetVariable;
|
---|
64 | }
|
---|
65 |
|
---|
66 | public abstract IEnumerable<double> GetEstimatedClassValues(IDataset dataset, IEnumerable<int> rows);
|
---|
67 | public abstract IClassificationSolution CreateClassificationSolution(IClassificationProblemData problemData);
|
---|
68 |
|
---|
69 | public virtual bool IsProblemDataCompatible(IClassificationProblemData problemData, out string errorMessage) {
|
---|
70 | return IsProblemDataCompatible(this, problemData, out errorMessage);
|
---|
71 | }
|
---|
72 |
|
---|
73 | public override bool IsProblemDataCompatible(IDataAnalysisProblemData problemData, out string errorMessage) {
|
---|
74 | if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
|
---|
75 | var classificationProblemData = problemData as IClassificationProblemData;
|
---|
76 | if (classificationProblemData == null)
|
---|
77 | throw new ArgumentException("The problem data is not a regression problem data. Instead a " + problemData.GetType().GetPrettyName() + " was provided.", "problemData");
|
---|
78 | return IsProblemDataCompatible(classificationProblemData, out errorMessage);
|
---|
79 | }
|
---|
80 |
|
---|
81 | public static bool IsProblemDataCompatible(IClassificationModel model, IClassificationProblemData problemData, out string errorMessage) {
|
---|
82 | if (model == null) throw new ArgumentNullException("model", "The provided model is null.");
|
---|
83 | if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
|
---|
84 | errorMessage = string.Empty;
|
---|
85 |
|
---|
86 | if (model.TargetVariable != problemData.TargetVariable)
|
---|
87 | errorMessage = string.Format("The target variable of the model {0} does not match the target variable of the problemData {1}.", model.TargetVariable, problemData.TargetVariable);
|
---|
88 |
|
---|
89 | var evaluationErrorMessage = string.Empty;
|
---|
90 | var datasetCompatible = model.IsDatasetCompatible(problemData.Dataset, out evaluationErrorMessage);
|
---|
91 | if (!datasetCompatible)
|
---|
92 | errorMessage += evaluationErrorMessage;
|
---|
93 |
|
---|
94 | return string.IsNullOrEmpty(errorMessage);
|
---|
95 | }
|
---|
96 |
|
---|
97 | #region events
|
---|
98 | public event EventHandler TargetVariableChanged;
|
---|
99 | private void OnTargetVariableChanged(object sender, EventArgs args) {
|
---|
100 | var changed = TargetVariableChanged;
|
---|
101 | if (changed != null)
|
---|
102 | changed(sender, args);
|
---|
103 | }
|
---|
104 | #endregion
|
---|
105 | }
|
---|
106 | }
|
---|