Changeset 135 for trunk/CrossPare/src/de/ugoe/cs/cpdp/training/ISetWiseTestdataAwareTrainingStrategy.java

Timestamp:

07/18/16 12:26:03 (8 years ago)

Author:

sherbold

Message:

• code documentation and formatting

File:

• trunk/CrossPare/src/de/ugoe/cs/cpdp/training/ISetWiseTestdataAwareTrainingStrategy.java (modified) (2 diffs)

trunk/CrossPare/src/de/ugoe/cs/cpdp/training/ISetWiseTestdataAwareTrainingStrategy.java

@@ +1 @@
+
 package de.ugoe.cs.cpdp.training;
 
@@ -4 +5 @@
 import weka.core.Instances;
 
+/**
+ * <p>
+ * Training strategy for training with access to the target data and one data set per input product.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ */
 public interface ISetWiseTestdataAwareTrainingStrategy extends ITrainer {
 
+    /**
+     * <p>
+     * Applies the training strategy.
+     * </p>
+     *
+     * @param traindataSet
+     *            the training data per product
+     * @param testdata
+     *            the test data from the target product
+     */
     void apply(SetUniqueList<Instances> traindataSet, Instances testdata);
 
+    /**
+     * <p>
+     * returns the name of the training strategy
+     * </p>
+     *
+     * @return the name
+     */
     String getName();
-    
+
+    // TODO: these two methods look like they should be removed and instead be handled using the parameters
     void setMethod(String method);
+
     void setThreshold(String threshold);
 }