Changeset 1906

Timestamp:

05/27/09 13:22:41 (16 years ago)

Author:

gkronber

Message:

Added interface IModel and a standard implementation and changed SVM models to include the range transform in the model. #650 (IAlgorithm and derived interfaces should provide properties to retrieve results)

Location:

trunk/sources

Files:

• HeuristicLab.GP.StructureIdentification/3.3/AlgorithmBase.cs (modified) (2 diffs)
• HeuristicLab.GP.StructureIdentification/3.3/StandardGP.cs (modified) (1 diff)
• HeuristicLab.Modeling/3.2/HeuristicLab.Modeling-3.2.csproj (modified) (1 diff)
• HeuristicLab.Modeling/3.2/IAlgorithm.cs (modified) (1 diff)
• HeuristicLab.Modeling/3.2/IModel.cs (added)
• HeuristicLab.Modeling/3.2/Model.cs (added)
• HeuristicLab.SupportVectorMachines/3.2/HeuristicLab.SupportVectorMachines-3.2.csproj (modified) (1 diff)
• HeuristicLab.SupportVectorMachines/3.2/SVMModel.cs (modified) (4 diffs)
• HeuristicLab.SupportVectorMachines/3.2/SupportVectorCreator.cs (modified) (2 diffs)
• HeuristicLab.SupportVectorMachines/3.2/SupportVectorEvaluator.cs (modified) (2 diffs)
• HeuristicLab.SupportVectorMachines/3.2/SupportVectorRegression.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.GP.StructureIdentification/3.3/AlgorithmBase.cs

@@ -70 +70 @@
     }
 
+    public virtual IModel Model {
+      get {
+        if (!engine.Terminated) throw new InvalidOperationException("The algorithm is still running. Wait until the algorithm is terminated to retrieve the result.");
+        IScope bestModelScope = engine.GlobalScope.GetVariableValue<IScope>("BestValidationSolution", false);
+        return CreateGPModel(bestModelScope);
+      }
+    }
+
     public virtual int Elites {
       get { return GetVariableInjector().GetVariable("Elites").GetValue<IntData>().Data; }
@@ -405 +413 @@
     }
 
+    protected internal virtual Model CreateGPModel(IScope bestModelScope) {
+      Model model = new Model();
+      Dataset ds = bestModelScope.GetVariableValue<Dataset>("Dataset", true);
+      model.Data = bestModelScope.GetVariableValue<IFunctionTree>("FunctionTree", false);
+      model.Dataset = ds;
+      model.TargetVariable = ds.GetVariableName(bestModelScope.GetVariableValue<IntData>("TargetVariable", true).Data);
+      model.TrainingMeanSquaredError = bestModelScope.GetVariableValue<DoubleData>("Quality", false).Data;
+      model.ValidationMeanSquaredError = bestModelScope.GetVariableValue<DoubleData>("ValidationQuality", false).Data;
+      return model;
+    }
+
     public override object Clone(IDictionary<Guid, object> clonedObjects) {
       AlgorithmBase clone = (AlgorithmBase)base.Clone(clonedObjects);

trunk/sources/HeuristicLab.GP.StructureIdentification/3.3/StandardGP.cs

@@ -312 +312 @@
     }
 
+    protected internal override Model CreateGPModel(IScope bestModelScope) {
+      Model model = base.CreateGPModel(bestModelScope);
+      model.TestMeanSquaredError = bestModelScope.GetVariableValue<DoubleData>("TestQuality", false).Data;
+      return model;
+    }
+
     public virtual IEditor CreateEditor() {
       return new StandardGpEditor(this);

trunk/sources/HeuristicLab.Modeling/3.2/HeuristicLab.Modeling-3.2.csproj

@@ -83 +83 @@
   <ItemGroup>
     <Compile Include="ClassificationProblemInjector.cs" />
+    <Compile Include="Model.cs" />
+    <Compile Include="IModel.cs" />
     <Compile Include="SimpleEvaluatorBase.cs" />
     <Compile Include="ITimeSeriesAlgorithm.cs" />

trunk/sources/HeuristicLab.Modeling/3.2/IAlgorithm.cs

@@ -31 +31 @@
     IOperator ProblemInjector { get; set; }
     IEngine Engine { get; }
+
+    IModel Model { get; }
   }
 }

trunk/sources/HeuristicLab.SupportVectorMachines/3.2/HeuristicLab.SupportVectorMachines-3.2.csproj

@@ -82 +82 @@
   <ItemGroup>
     <Compile Include="SupportVectorRegression.cs" />
-    <Compile Include="SVMRangeTransform.cs" />
     <Compile Include="SVMModel.cs" />
     <Compile Include="HeuristicLabSupportVectorMachinesPlugin.cs" />

trunk/sources/HeuristicLab.SupportVectorMachines/3.2/SVMModel.cs

@@ -29 +29 @@
 
 namespace HeuristicLab.Data {
-  public class SVMModel : ObjectData {
+  public class SVMModel : ItemBase {
+    private SVM.Model model;
     /// <summary>
     /// Gets or sets the SVM model.
     /// </summary>
-    /// <remarks>Uses property <see cref="ObjectData.Data"/> of base class <see cref="ObjectData"></see>. 
-    /// No own data storage present.</remarks>
-    public new SVM.Model Data {
-      get { return (SVM.Model)base.Data; }
-      set { base.Data = value; }
+    public SVM.Model Model {
+      get { return model; }
+      set { model = value; }
+    }
+
+
+    /// <summary>
+    /// Gets or sets the range transformation for the model.
+    /// </summary>
+    private SVM.RangeTransform rangeTransform;
+    public SVM.RangeTransform RangeTransform {
+      get { return rangeTransform; }
+      set { rangeTransform = value; }
     }
 
@@ -49 +58 @@
       clonedObjects.Add(Guid, clone);
       // beware we are only using a shallow copy here! (gkronber)
-      clone.Data = Data;
+      clone.Model = Model;
+      clone.RangeTransform = RangeTransform;
       return clone;
     }
@@ -64 +74 @@
     public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid, IStorable> persistedObjects) {
       XmlNode node = base.GetXmlNode(name, document, persistedObjects);
-      XmlNode data = document.CreateElement("Data");
-
+      XmlNode model = document.CreateElement("Model");
       using (MemoryStream stream = new MemoryStream()) {
-        SVM.Model.Write(stream, Data);
+        SVM.Model.Write(stream, Model);
         stream.Seek(0, System.IO.SeekOrigin.Begin);
         StreamReader reader = new StreamReader(stream);
-        data.InnerText = reader.ReadToEnd();
-        node.AppendChild(data);
+        model.InnerText = reader.ReadToEnd();
+        node.AppendChild(model);
       }
+
+      XmlNode rangeTransform = document.CreateElement("RangeTransform");
+      using (MemoryStream stream = new MemoryStream()) {
+        SVM.RangeTransform.Write(stream, RangeTransform);
+        stream.Seek(0, System.IO.SeekOrigin.Begin);
+        StreamReader reader = new StreamReader(stream);
+        rangeTransform.InnerText = reader.ReadToEnd();
+        node.AppendChild(rangeTransform);
+      }
+
       return node;
     }
@@ -84 +103 @@
     public override void Populate(XmlNode node, IDictionary<Guid, IStorable> restoredObjects) {
       base.Populate(node, restoredObjects);
-      XmlNode data = node.SelectSingleNode("Data");
-      using (MemoryStream stream = new MemoryStream(Encoding.ASCII.GetBytes(data.InnerText))) {
-        Data = SVM.Model.Read(stream);
+      XmlNode model = node.SelectSingleNode("Model");
+      using (MemoryStream stream = new MemoryStream(Encoding.ASCII.GetBytes(model.InnerText))) {
+        Model = SVM.Model.Read(stream);
+      }
+      XmlNode rangeTransform = node.SelectSingleNode("RangeTransform");
+      using (MemoryStream stream = new MemoryStream(Encoding.ASCII.GetBytes(rangeTransform.InnerText))) {
+        RangeTransform = SVM.RangeTransform.Read(stream);
       }
     }

trunk/sources/HeuristicLab.SupportVectorMachines/3.2/SupportVectorCreator.cs

@@ -53 +53 @@
       AddVariableInfo(new VariableInfo("SVMGamma", "Gamma parameter in kernel function", typeof(DoubleData), VariableKind.In));
       AddVariableInfo(new VariableInfo("SVMModel", "Represent the model learned by the SVM", typeof(SVMModel), VariableKind.New | VariableKind.Out));
-      AddVariableInfo(new VariableInfo("SVMRangeTransform", "The applied transformation during the learning the model", typeof(SVMRangeTransform), VariableKind.New | VariableKind.Out));
+//    AddVariableInfo(new VariableInfo("SVMRangeTransform", "The applied transformation during the learning the model", typeof(SVMRangeTransform), VariableKind.New | VariableKind.Out));
     }
 
@@ -92 +92 @@
         //persist variables in scope
         SVMModel modelData = new SVMModel();
-        modelData.Data = model;
+        modelData.Model = model;
+        modelData.RangeTransform = rangeTransform;
         scope.AddVariable(new Variable(scope.TranslateName("SVMModel"), modelData));
-        SVMRangeTransform rangeTransformData = new SVMRangeTransform();
-        rangeTransformData.Data = rangeTransform;
-        scope.AddVariable(new Variable(scope.TranslateName("SVMRangeTransform"), rangeTransformData));
+        //SVMRangeTransform rangeTransformData = new SVMRangeTransform();
+        //rangeTransformData.Data = rangeTransform;
+        //scope.AddVariable(new Variable(scope.TranslateName("SVMRangeTransform"), rangeTransformData));
         return null;
       } else {

trunk/sources/HeuristicLab.SupportVectorMachines/3.2/SupportVectorEvaluator.cs

@@ -41 +41 @@
 
       AddVariableInfo(new VariableInfo("SVMModel", "Represent the model learned by the SVM", typeof(SVMModel), VariableKind.In));
-      AddVariableInfo(new VariableInfo("SVMRangeTransform", "The applied transformation during the learning the model", typeof(SVMRangeTransform), VariableKind.In));
+      // AddVariableInfo(new VariableInfo("SVMRangeTransform", "The applied transformation during the learning the model", typeof(SVMRangeTransform), VariableKind.In));
 
       AddVariableInfo(new VariableInfo("Values", "Target vs predicted values", typeof(DoubleMatrixData), VariableKind.New | VariableKind.Out));
@@ -54 +54 @@
       int end = GetVariableValue<IntData>("SamplesEnd", scope, true).Data;
 
-      SVM.Model model = GetVariableValue<SVMModel>("SVMModel", scope, true).Data;
-      SVM.RangeTransform rangeTransform = GetVariableValue<SVMRangeTransform>("SVMRangeTransform", scope, true).Data;
+      SVMModel modelData = GetVariableValue<SVMModel>("SVMModel", scope, true);
+      // SVM.RangeTransform rangeTransform = GetVariableValue<SVMRangeTransform>("SVMRangeTransform", scope, true).Data;
 
       SVM.Problem problem = SVMHelper.CreateSVMProblem(dataset, allowedFeatures, targetVariable, start, end);
-      SVM.Problem scaledProblem = SVM.Scaling.Scale(problem, rangeTransform);
+      SVM.Problem scaledProblem = SVM.Scaling.Scale(problem, modelData.RangeTransform);
 
       double[,] values = new double[end-start, 2];
       for (int i = 0; i < end - start; i++) {
-        values[i,0] = SVM.Prediction.Predict(model, scaledProblem.X[i]);
+        values[i,0] = SVM.Prediction.Predict(modelData.Model, scaledProblem.X[i]);
         values[i,1] = dataset.Samples[(start + i) * dataset.Columns + targetVariable];
       }

trunk/sources/HeuristicLab.SupportVectorMachines/3.2/SupportVectorRegression.cs

@@ -58 +58 @@
     }
 
+    public IModel Model {
+      get {
+        if (!engine.Terminated) throw new InvalidOperationException("The algorithm is still running. Wait until the algorithm is terminated to retrieve the result.");
+        IScope bestModelScope = engine.GlobalScope.GetVariableValue<IScope>("BestValidationSolution", false);
+        return CreateSVMModel(bestModelScope);
+      }
+    }
+
     public DoubleArrayData NuList {
       get { return GetVariableInjector().GetVariable("NuList").GetValue<DoubleArrayData>(); }
@@ -127 +135 @@
       modelCreator.GetVariableInfo("SVMModel").ActualName = "Model";
       modelCreator.GetVariableInfo("SVMNu").ActualName = "Nu";
-      modelCreator.GetVariableInfo("SVMRangeTransform").ActualName = "RangeTransform";
       modelCreator.GetVariableInfo("SVMType").ActualName = "Type";
-
 
       modelProcessor.AddSubOperator(modelCreator);
@@ -196 +202 @@
       evaluator.Name = p + "SimpleEvaluator";
       evaluator.GetVariableInfo("SVMModel").ActualName = "Model";
-      evaluator.GetVariableInfo("SVMRangeTransform").ActualName = "RangeTransform";
       evaluator.GetVariableInfo("SamplesStart").ActualName = p + "SamplesStart";
       evaluator.GetVariableInfo("SamplesEnd").ActualName = p + "SamplesEnd";
@@ -277 +282 @@
     }
 
+    protected internal virtual Model CreateSVMModel(IScope bestModelScope) {
+      Model model = new Model();
+      model.Data = bestModelScope.GetVariableValue<SVMModel>("BestValidationModel", false);
+      return model;
+    }
+
     private IOperator GetVariableInjector() {
       return GetMainOperator().SubOperators[0];