Format documentation with new formatting settings
Project: http://git-wip-us.apache.org/repos/asf/incubator-samoa/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-samoa/commit/5543ecd3 Tree: http://git-wip-us.apache.org/repos/asf/incubator-samoa/tree/5543ecd3 Diff: http://git-wip-us.apache.org/repos/asf/incubator-samoa/diff/5543ecd3 Branch: refs/heads/master Commit: 5543ecd3a7fee04f5cd58849fd8166b1a49bee2e Parents: 73a6824 Author: Matthieu Morel <[email protected]> Authored: Mon Feb 2 18:20:40 2015 +0100 Committer: Matthieu Morel <[email protected]> Committed: Mon Feb 2 18:20:40 2015 +0100 ---------------------------------------------------------------------- .../labs/samoa/core/EntranceProcessor.java | 16 +- .../com/yahoo/labs/samoa/core/Processor.java | 11 +- .../labs/samoa/core/SerializableInstance.java | 3 +- .../samoa/evaluation/PerformanceEvaluator.java | 9 +- ...indowClassificationPerformanceEvaluator.java | 3 +- .../labs/samoa/evaluation/measures/CMM.java | 27 +-- .../evaluation/measures/CMM_GTAnalysis.java | 78 +++---- .../HelloWorldDestinationProcessor.java | 3 +- .../labs/samoa/examples/HelloWorldTask.java | 14 +- .../labs/samoa/learners/AdaptiveLearner.java | 5 +- .../com/yahoo/labs/samoa/learners/Learner.java | 5 +- .../learners/classifiers/LocalLearner.java | 10 +- .../classifiers/LocalLearnerProcessor.java | 5 +- .../samoa/learners/classifiers/NaiveBayes.java | 26 +-- .../classifiers/SimpleClassifierAdapter.java | 10 +- .../classifiers/rules/AMRulesRegressor.java | 5 +- .../rules/HorizontalAMRulesRegressor.java | 5 +- .../rules/VerticalAMRulesRegressor.java | 4 +- .../centralized/AMRulesRegressorProcessor.java | 50 +++-- .../classifiers/rules/common/ActiveRule.java | 3 +- .../classifiers/rules/common/PassiveRule.java | 3 +- .../classifiers/rules/common/Perceptron.java | 3 +- .../learners/classifiers/rules/common/Rule.java | 3 +- .../rules/common/RuleActiveLearningNode.java | 3 +- .../rules/common/RuleActiveRegressionNode.java | 3 +- .../rules/common/RulePassiveLearningNode.java | 4 +- .../rules/common/RulePassiveRegressionNode.java | 4 +- .../rules/common/RuleRegressionNode.java | 3 +- .../distributed/AMRulesAggregatorProcessor.java | 6 +- .../rules/distributed/RuleContentEvent.java | 3 +- .../trees/AttributeBatchContentEvent.java | 3 +- .../trees/AttributeContentEvent.java | 11 +- .../classifiers/trees/ComputeContentEvent.java | 13 +- .../classifiers/trees/ControlContentEvent.java | 3 +- .../classifiers/trees/DeleteContentEvent.java | 4 +- .../classifiers/trees/FilterProcessor.java | 9 +- .../learners/classifiers/trees/FoundNode.java | 16 +- .../classifiers/trees/InactiveLearningNode.java | 5 +- .../trees/LocalResultContentEvent.java | 10 +- .../trees/LocalStatisticsProcessor.java | 6 +- .../trees/ModelAggregatorProcessor.java | 45 ++-- .../samoa/learners/classifiers/trees/Node.java | 12 +- .../learners/classifiers/trees/SplitNode.java | 7 +- .../trees/VerticalHoeffdingTree.java | 5 +- .../clusterers/ClustreamClustererAdapter.java | 10 +- .../clusterers/LocalClustererAdapter.java | 10 +- .../yahoo/labs/samoa/moa/AbstractMOAObject.java | 4 +- .../com/yahoo/labs/samoa/moa/MOAObject.java | 10 +- .../moa/classifiers/AbstractClassifier.java | 30 +-- .../labs/samoa/moa/classifiers/Classifier.java | 15 +- .../labs/samoa/moa/classifiers/Regressor.java | 3 +- .../AttributeClassObserver.java | 8 +- ...BinaryTreeNumericAttributeClassObserver.java | 7 +- ...NumericAttributeClassObserverRegression.java | 9 +- .../DiscreteAttributeClassObserver.java | 6 +- .../FIMTDDNumericAttributeClassObserver.java | 9 +- .../GaussianNumericAttributeClassObserver.java | 7 +- ...waldKhannaNumericAttributeClassObserver.java | 7 +- .../NominalAttributeClassObserver.java | 5 +- .../NullAttributeClassObserver.java | 5 +- .../NumericAttributeClassObserver.java | 5 +- .../VFMLNumericAttributeClassObserver.java | 5 +- .../InstanceConditionalBinaryTest.java | 3 +- .../InstanceConditionalTest.java | 6 +- .../NominalAttributeBinaryTest.java | 3 +- .../NominalAttributeMultiwayTest.java | 3 +- .../NumericAttributeBinaryTest.java | 3 +- .../classifiers/core/driftdetection/ADWIN.java | 8 +- .../driftdetection/ADWINChangeDetector.java | 8 +- .../driftdetection/AbstractChangeDetector.java | 12 +- .../core/driftdetection/ChangeDetector.java | 12 +- .../classifiers/core/driftdetection/DDM.java | 3 +- .../classifiers/core/driftdetection/EDDM.java | 5 +- .../core/driftdetection/EWMAChartDM.java | 3 +- .../core/splitcriteria/GiniSplitCriterion.java | 5 +- .../splitcriteria/InfoGainSplitCriterion.java | 5 +- .../InfoGainSplitCriterionMultilabel.java | 5 +- .../core/splitcriteria/SplitCriterion.java | 10 +- ...IMTDDNumericAttributeClassLimitObserver.java | 3 +- .../NumericAttributeBinaryRulePredicate.java | 3 +- .../core/voting/AbstractErrorWeightedVote.java | 3 +- .../rules/core/voting/ErrorWeightedVote.java | 3 +- .../core/voting/InverseErrorWeightedVote.java | 3 +- .../yahoo/labs/samoa/moa/cluster/CFCluster.java | 3 +- .../yahoo/labs/samoa/moa/cluster/Cluster.java | 4 +- .../labs/samoa/moa/cluster/SphereCluster.java | 22 +- .../yahoo/labs/samoa/moa/clusterers/KMeans.java | 18 +- .../moa/clusterers/clustream/Clustream.java | 4 +- .../clusterers/clustream/ClustreamKernel.java | 6 +- .../moa/clusterers/clustream/WithKmeans.java | 12 +- .../yahoo/labs/samoa/moa/core/FastVector.java | 3 +- .../labs/samoa/moa/core/GaussianEstimator.java | 6 +- .../yahoo/labs/samoa/moa/core/MiscUtils.java | 3 +- .../yahoo/labs/samoa/moa/core/Statistics.java | 63 +++--- .../com/yahoo/labs/samoa/moa/core/Utils.java | 206 ++++++++----------- .../LearningPerformanceEvaluator.java | 9 +- .../yahoo/labs/samoa/moa/learners/Learner.java | 31 ++- .../samoa/moa/options/AbstractClassOption.java | 10 +- .../moa/options/AbstractOptionHandler.java | 8 +- .../labs/samoa/moa/options/OptionsHandler.java | 5 +- .../labs/samoa/moa/streams/ExampleStream.java | 10 +- .../samoa/moa/tasks/ResultPreviewListener.java | 9 +- .../com/yahoo/labs/samoa/moa/tasks/Task.java | 11 +- .../yahoo/labs/samoa/streams/FileStream.java | 6 +- .../streams/PrequentialSourceProcessor.java | 3 +- .../labs/samoa/streams/fs/FileStreamSource.java | 12 +- .../labs/samoa/tasks/PrequentialEvaluation.java | 6 +- .../java/com/yahoo/labs/samoa/tasks/Task.java | 8 +- .../AbstractEntranceProcessingItem.java | 5 +- .../samoa/topology/AbstractProcessingItem.java | 8 +- .../labs/samoa/topology/AbstractStream.java | 5 +- .../labs/samoa/topology/AbstractTopology.java | 3 +- .../labs/samoa/topology/ComponentFactory.java | 14 +- .../samoa/topology/EntranceProcessingItem.java | 3 +- .../yahoo/labs/samoa/topology/ISubmitter.java | 3 +- .../topology/LocalEntranceProcessingItem.java | 23 +-- .../labs/samoa/topology/ProcessingItem.java | 13 +- .../com/yahoo/labs/samoa/topology/Topology.java | 3 +- .../labs/samoa/topology/TopologyBuilder.java | 9 +- .../labs/samoa/utils/StreamDestination.java | 8 +- .../labs/samoa/instances/InstancesHeader.java | 3 +- .../samoa/instances/SparseInstanceData.java | 3 +- .../samoa/topology/impl/S4ProcessingItem.java | 3 +- .../samoa/topology/impl/SamoaSerializer.java | 5 +- .../samoa/topology/impl/SamoaSystemFactory.java | 5 +- .../labs/samoa/topology/impl/SamzaEngine.java | 3 +- .../impl/SamzaEntranceProcessingItem.java | 3 +- .../topology/impl/SamzaProcessingItem.java | 3 +- .../labs/samoa/topology/impl/SamzaStream.java | 5 +- .../labs/samoa/utils/SamzaConfigFactory.java | 8 +- .../labs/samoa/utils/SamzaKryoSerdeFactory.java | 3 +- .../samoa/topology/impl/StormSamoaUtils.java | 3 +- .../topology/impl/StormTopologySubmitter.java | 5 +- .../java/com/yahoo/labs/samoa/TestParams.java | 3 +- .../java/com/yahoo/labs/samoa/TestUtils.java | 36 ++-- .../topology/impl/ThreadsEventRunnable.java | 10 +- .../impl/ThreadsProcessingItemInstance.java | 5 +- 137 files changed, 569 insertions(+), 852 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/core/EntranceProcessor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/core/EntranceProcessor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/core/EntranceProcessor.java index e9eac30..2371c02 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/core/EntranceProcessor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/core/EntranceProcessor.java @@ -25,15 +25,14 @@ import java.io.Serializable; import com.github.javacliparser.Configurable; /** - * An EntranceProcessor is a specific kind of processor dedicated to providing - * events to inject in the topology. It can be connected to a single output - * stream. + * An EntranceProcessor is a specific kind of processor dedicated to providing events to inject in the topology. It can + * be connected to a single output stream. */ public interface EntranceProcessor extends Serializable, Configurable, Processor { /** - * Initializes the Processor. This method is called once after the topology is - * set up and before any call to the {@link nextTuple} method. + * Initializes the Processor. This method is called once after the topology is set up and before any call to the + * {@link nextTuple} method. * * @param the * identifier of the processor. @@ -48,14 +47,13 @@ public interface EntranceProcessor extends Serializable, Configurable, Processor /** * Checks whether a new event is ready to be processed. * - * @return true if the EntranceProcessor is ready to provide the next event, - * false otherwise. + * @return true if the EntranceProcessor is ready to provide the next event, false otherwise. */ public boolean hasNext(); /** - * Provides the next tuple to be processed by the topology. This method is the - * entry point for external events into the topology. + * Provides the next tuple to be processed by the topology. This method is the entry point for external events into + * the topology. * * @return the next event to be processed. */ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/core/Processor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/core/Processor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/core/Processor.java index b02d33c..7659b26 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/core/Processor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/core/Processor.java @@ -30,8 +30,7 @@ import com.github.javacliparser.Configurable; public interface Processor extends Serializable, Configurable { /** - * Entry point for the {@link Processor} code. This method is called once for - * every event received. + * Entry point for the {@link Processor} code. This method is called once for every event received. * * @param event * the event to be processed. @@ -40,8 +39,8 @@ public interface Processor extends Serializable, Configurable { boolean process(ContentEvent event); /** - * Initializes the Processor. This method is called once after the topology is - * set up and before any call to the {@link process} method. + * Initializes the Processor. This method is called once after the topology is set up and before any call to the + * {@link process} method. * * @param id * the identifier of the processor. @@ -49,8 +48,8 @@ public interface Processor extends Serializable, Configurable { void onCreate(int id); /** - * Creates a copy of a processor. This method is used to instantiate multiple - * instances of the same {@link Processsor}. + * Creates a copy of a processor. This method is used to instantiate multiple instances of the same {@link Processsor} + * . * * @param processor * the processor to be copied. http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/core/SerializableInstance.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/core/SerializableInstance.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/core/SerializableInstance.java index a4d5b24..56fa127 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/core/SerializableInstance.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/core/SerializableInstance.java @@ -31,8 +31,7 @@ import com.yahoo.labs.samoa.instances.Instance; //import weka.core.Instance; /** - * The Class SerializableInstance. This class is needed for serialization of - * kryo + * The Class SerializableInstance. This class is needed for serialization of kryo */ public class SerializableInstance extends DenseInstance { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/PerformanceEvaluator.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/PerformanceEvaluator.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/PerformanceEvaluator.java index 8f81392..d7837d4 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/PerformanceEvaluator.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/PerformanceEvaluator.java @@ -26,8 +26,7 @@ import com.yahoo.labs.samoa.moa.core.Measurement; import com.yahoo.labs.samoa.instances.Instance; /** - * Interface implemented by learner evaluators to monitor the results of the - * learning process. + * Interface implemented by learner evaluators to monitor the results of the learning process. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ @@ -35,8 +34,7 @@ import com.yahoo.labs.samoa.instances.Instance; public interface PerformanceEvaluator extends MOAObject { /** - * Resets this evaluator. It must be similar to starting a new evaluator from - * scratch. + * Resets this evaluator. It must be similar to starting a new evaluator from scratch. * */ public void reset(); @@ -47,8 +45,7 @@ public interface PerformanceEvaluator extends MOAObject { * @param inst * the instance to be classified * @param classVotes - * an array containing the estimated membership probabilities of the - * test instance in each class + * an array containing the estimated membership probabilities of the test instance in each class * @return an array of measurements monitored in this evaluator */ public void addResult(Instance inst, double[] classVotes); http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/WindowClassificationPerformanceEvaluator.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/WindowClassificationPerformanceEvaluator.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/WindowClassificationPerformanceEvaluator.java index c1758c9..7917a7f 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/WindowClassificationPerformanceEvaluator.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/WindowClassificationPerformanceEvaluator.java @@ -27,8 +27,7 @@ import com.yahoo.labs.samoa.instances.Instance; import com.yahoo.labs.samoa.instances.Utils; /** - * Classification evaluator that updates evaluation results using a sliding - * window. + * Classification evaluator that updates evaluation results using a sliding window. * * @author Albert Bifet (abifet at cs dot waikato dot ac dot nz) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM.java index 568f7c5..35184f6 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM.java @@ -33,12 +33,9 @@ import java.util.ArrayList; * * CMM: Main class * - * Reference: Kremer et al., - * "An Effective Evaluation Measure for Clustering on Evolving Data Streams", - * KDD, 2011 + * Reference: Kremer et al., "An Effective Evaluation Measure for Clustering on Evolving Data Streams", KDD, 2011 * - * @author Timm jansen Data Management and Data Exploration Group, RWTH Aachen - * University + * @author Timm jansen Data Management and Data Exploration Group, RWTH Aachen University */ public class CMM extends MeasureCollection { @@ -66,8 +63,7 @@ public class CMM extends MeasureCollection { private int numFClusters; /** - * number of cluster in the adjusted groundtruth clustering that was - * calculated through the groundtruth analysis + * number of cluster in the adjusted groundtruth clustering that was calculated through the groundtruth analysis */ private int numGT0Classes; @@ -77,14 +73,12 @@ public class CMM extends MeasureCollection { private int matchMap[]; /** - * pointInclusionProbFC[p][C] contains the probability of point p being - * included in cluster C + * pointInclusionProbFC[p][C] contains the probability of point p being included in cluster C */ private double[][] pointInclusionProbFC; /** - * threshold that defines when a point is being considered belonging to a - * cluster + * threshold that defines when a point is being considered belonging to a cluster */ private double pointInclusionProbThreshold = 0.5; @@ -104,8 +98,7 @@ public class CMM extends MeasureCollection { public boolean enableClassMerge = true; /** - * enable/disable model error when enabled errors that are caused by the - * underling cluster model will not be counted + * enable/disable model error when enabled errors that are caused by the underling cluster model will not be counted */ public boolean enableModelError = true; @@ -146,8 +139,7 @@ public class CMM extends MeasureCollection { } /** - * calculates the CMM specific matching between found clusters and ground - * truth clusters + * calculates the CMM specific matching between found clusters and ground truth clusters */ private void calculateMatching() { @@ -303,9 +295,8 @@ public class CMM extends MeasureCollection { double totalErrorMax = 0.0; /** - * mainly iterate over all points and find the right error value for the - * point. within the same run calculate various other stuff like coverage - * etc... + * mainly iterate over all points and find the right error value for the point. within the same run calculate + * various other stuff like coverage etc... */ for (int p = 0; p < numPoints; p++) { CMMPoint cmdp = gtAnalysis.getPoint(p); http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM_GTAnalysis.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM_GTAnalysis.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM_GTAnalysis.java index c31fa74..6555625 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM_GTAnalysis.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/evaluation/measures/CMM_GTAnalysis.java @@ -33,12 +33,9 @@ import java.util.Iterator; * * CMM: Ground truth analysis * - * Reference: Kremer et al., - * "An Effective Evaluation Measure for Clustering on Evolving Data Streams", - * KDD, 2011 + * Reference: Kremer et al., "An Effective Evaluation Measure for Clustering on Evolving Data Streams", KDD, 2011 * - * @author Timm jansen Data Management and Data Exploration Group, RWTH Aachen - * University + * @author Timm jansen Data Management and Data Exploration Group, RWTH Aachen University */ /* @@ -78,8 +75,8 @@ public class CMM_GTAnalysis { private int numGTClusters; /** - * number of classes of the original ground truth, in case of a micro - * clustering ground truth this differs from numGTClusters + * number of classes of the original ground truth, in case of a micro clustering ground truth this differs from + * numGTClusters */ private int numGTClasses; @@ -94,11 +91,10 @@ public class CMM_GTAnalysis { private int numDims; /** - * mapping between true cluster ID/class label of the original ground truth - * and the internal cluster ID/working class label. + * mapping between true cluster ID/class label of the original ground truth and the internal cluster ID/working class + * label. * - * different original cluster IDs might map to the same new cluster ID due to - * merging of two clusters + * different original cluster IDs might map to the same new cluster ID due to merging of two clusters */ private HashMap<Integer, Integer> mapTrueLabelToWorkLabel; @@ -108,15 +104,14 @@ public class CMM_GTAnalysis { private int[] mergeMap; /** - * number of non-noise points that will create an error due to the underlying - * clustering model (e.g. point being covered by two clusters representing - * different classes) + * number of non-noise points that will create an error due to the underlying clustering model (e.g. point being + * covered by two clusters representing different classes) */ private int noiseErrorByModel; /** - * number of noise points that will create an error due to the underlying - * clustering model (e.g. noise point being covered by a cluster) + * number of noise points that will create an error due to the underlying clustering model (e.g. noise point being + * covered by a cluster) */ private int pointErrorByModel; @@ -133,22 +128,19 @@ public class CMM_GTAnalysis { private int knnNeighbourhood = 2; /** - * the threshold which defines when ground truth clusters will be merged. set - * to 1 to disable merging + * the threshold which defines when ground truth clusters will be merged. set to 1 to disable merging */ private double tauConnection = 0.5; /** - * experimental (default: disabled) separate k for points to cluster and - * cluster to cluster + * experimental (default: disabled) separate k for points to cluster and cluster to cluster */ private double clusterConnectionMaxPoints = knnNeighbourhood; /** - * experimental (default: disabled) use exponential connectivity function to - * model different behavior: closer points will have a stronger connection - * compared to the linear function. Use ConnRefXValue and ConnX to better - * parameterize lambda, which controls the decay of the connectivity + * experimental (default: disabled) use exponential connectivity function to model different behavior: closer points + * will have a stronger connection compared to the linear function. Use ConnRefXValue and ConnX to better parameterize + * lambda, which controls the decay of the connectivity */ private boolean useExpConnectivity = false; private double lambdaConnRefXValue = 0.01; @@ -201,8 +193,8 @@ public class CMM_GTAnalysis { } /** - * Retruns the current working label of the cluster the point belongs to. - * The label can change due to merging of clusters. + * Retruns the current working label of the cluster the point belongs to. The label can change due to merging of + * clusters. * * @return the current working class label */ @@ -215,8 +207,7 @@ public class CMM_GTAnalysis { } /** - * Main class to model the new clusters that will be the output of the cluster - * analysis + * Main class to model the new clusters that will be the output of the cluster analysis * */ protected class GTCluster { @@ -224,12 +215,10 @@ public class CMM_GTAnalysis { private ArrayList<Integer> points = new ArrayList<Integer>(); /** - * a new GT cluster consists of one or more "old" GT clusters. - * Connected/overlapping clusters cannot be merged directly because of the - * underlying cluster model. E.g. for merging two spherical clusters the new - * cluster sphere can cover a lot more space then two separate smaller - * spheres. To keep the original coverage we need to keep the orignal - * clusters and merge them on an abstract level. + * a new GT cluster consists of one or more "old" GT clusters. Connected/overlapping clusters cannot be merged + * directly because of the underlying cluster model. E.g. for merging two spherical clusters the new cluster sphere + * can cover a lot more space then two separate smaller spheres. To keep the original coverage we need to keep the + * orignal clusters and merge them on an abstract level. */ private ArrayList<Integer> clusterRepresentations = new ArrayList<Integer>(); @@ -289,8 +278,8 @@ public class CMM_GTAnalysis { } /** - * calculate knn distances of points within own cluster + average knn - * distance and average knn distance deviation of all points + * calculate knn distances of points within own cluster + average knn distance and average knn distance deviation of + * all points */ private void calculateKnn() { for (int p0 : points) { @@ -601,8 +590,7 @@ public class CMM_GTAnalysis { * @param pointIDs * list of point IDs to check * @param knnDist - * sorted list of smallest knn distances (can already be filled to - * make updates possible) + * sorted list of smallest knn distances (can already be filled to make updates possible) * @param knnPointIndex * list of corresponding knn indices */ @@ -647,8 +635,7 @@ public class CMM_GTAnalysis { } /** - * Calculate connections between clusters and merge clusters accordingly as - * long as connections exceed threshold + * Calculate connections between clusters and merge clusters accordingly as long as connections exceed threshold */ private void calculateGTClusterConnections() { for (int c0 = 0; c0 < gt0Clusters.size(); c0++) { @@ -700,8 +687,8 @@ public class CMM_GTAnalysis { } /** - * Calculates how well the original clusters are separable. Small values - * indicate bad separability, values close to 1 indicate good separability + * Calculates how well the original clusters are separable. Small values indicate bad separability, values close to 1 + * indicate good separability * * @return index of seperability */ @@ -722,8 +709,8 @@ public class CMM_GTAnalysis { } /** - * Calculates how well noise is separable from the given clusters Small values - * indicate bad separability, values close to 1 indicate good separability + * Calculates how well noise is separable from the given clusters Small values indicate bad separability, values close + * to 1 indicate good separability * * @return index of noise separability */ @@ -750,8 +737,7 @@ public class CMM_GTAnalysis { } /** - * Calculates the relative number of errors being caused by the underlying - * cluster model + * Calculates the relative number of errors being caused by the underlying cluster model * * @return quality of the model */ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldDestinationProcessor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldDestinationProcessor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldDestinationProcessor.java index 3d8aac7..b2739be 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldDestinationProcessor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldDestinationProcessor.java @@ -24,8 +24,7 @@ import com.yahoo.labs.samoa.core.ContentEvent; import com.yahoo.labs.samoa.core.Processor; /** - * Example {@link Processor} that simply prints the received events to standard - * output. + * Example {@link Processor} that simply prints the received events to standard output. */ public class HelloWorldDestinationProcessor implements Processor { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldTask.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldTask.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldTask.java index 2c8e36c..8a3d8c7 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldTask.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/examples/HelloWorldTask.java @@ -36,15 +36,13 @@ import com.yahoo.labs.samoa.topology.Topology; import com.yahoo.labs.samoa.topology.TopologyBuilder; /** - * Example {@link Task} in SAMOA. This task simply sends events from a source - * {@link HelloWorldSourceProcessor} to a destination - * {@link HelloWorldDestinationProcessor}. The events are random integers - * generated by the source and encapsulated in a {@link HelloWorldContentEvent}. - * The destination prints the content of the event to standard output, prepended - * by the processor id. + * Example {@link Task} in SAMOA. This task simply sends events from a source {@link HelloWorldSourceProcessor} to a + * destination {@link HelloWorldDestinationProcessor}. The events are random integers generated by the source and + * encapsulated in a {@link HelloWorldContentEvent}. The destination prints the content of the event to standard output, + * prepended by the processor id. * - * The task has 2 main options: the number of events the source will generate - * (-i) and the parallelism level of the destination (-p). + * The task has 2 main options: the number of events the source will generate (-i) and the parallelism level of the + * destination (-p). */ public class HelloWorldTask implements Task, Configurable { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/AdaptiveLearner.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/AdaptiveLearner.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/AdaptiveLearner.java index e465b7d..aa740be 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/AdaptiveLearner.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/AdaptiveLearner.java @@ -28,9 +28,8 @@ import com.yahoo.labs.samoa.moa.classifiers.core.driftdetection.ChangeDetector; import com.yahoo.labs.samoa.topology.Stream; /** - * The Interface Adaptive Learner. Initializing Classifier should initalize PI - * to connect the Classifier with the input stream and initialize result stream - * so that other PI can connect to the classification result of this classifier + * The Interface Adaptive Learner. Initializing Classifier should initalize PI to connect the Classifier with the input + * stream and initialize result stream so that other PI can connect to the classification result of this classifier */ public interface AdaptiveLearner { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/Learner.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/Learner.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/Learner.java index 636b023..4d8db02 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/Learner.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/Learner.java @@ -29,9 +29,8 @@ import java.io.Serializable; import java.util.Set; /** - * The Interface Classifier. Initializing Classifier should initalize PI to - * connect the Classifier with the input stream and initialize result stream so - * that other PI can connect to the classification result of this classifier + * The Interface Classifier. Initializing Classifier should initalize PI to connect the Classifier with the input stream + * and initialize result stream so that other PI can connect to the classification result of this classifier */ public interface Learner extends Serializable { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearner.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearner.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearner.java index 80ddbd2..c08a8c1 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearner.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearner.java @@ -41,19 +41,17 @@ public interface LocalLearner extends Serializable { LocalLearner create(); /** - * Predicts the class memberships for a given instance. If an instance is - * unclassified, the returned array elements must be all zero. + * Predicts the class memberships for a given instance. If an instance is unclassified, the returned array elements + * must be all zero. * * @param inst * the instance to be classified - * @return an array containing the estimated membership probabilities of the - * test instance in each class + * @return an array containing the estimated membership probabilities of the test instance in each class */ double[] getVotesForInstance(Instance inst); /** - * Resets this classifier. It must be similar to starting a new classifier - * from scratch. + * Resets this classifier. It must be similar to starting a new classifier from scratch. * */ void resetLearning(); http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearnerProcessor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearnerProcessor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearnerProcessor.java index 978a839..c9ecc0b 100755 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearnerProcessor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/LocalLearnerProcessor.java @@ -124,9 +124,8 @@ final public class LocalLearnerProcessor implements Processor { } /** - * Gets whether this classifier correctly classifies an instance. Uses - * getVotesForInstance to obtain the prediction and the instance to obtain its - * true class. + * Gets whether this classifier correctly classifies an instance. Uses getVotesForInstance to obtain the prediction + * and the instance to obtain its true class. * * * @param inst http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/NaiveBayes.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/NaiveBayes.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/NaiveBayes.java index 915d09b..d0dc2c9 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/NaiveBayes.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/NaiveBayes.java @@ -34,8 +34,7 @@ import com.yahoo.labs.samoa.moa.core.GaussianEstimator; /** * Implementation of a non-distributed Naive Bayes classifier. * - * At the moment, the implementation models all attributes as numeric - * attributes. + * At the moment, the implementation models all attributes as numeric attributes. * * @author Olivier Van Laere (vanlaere yahoo-inc dot com) */ @@ -102,23 +101,21 @@ public class NaiveBayes implements LocalLearner { } /** - * Predicts the class memberships for a given instance. If an instance is - * unclassified, the returned array elements will be all zero. + * Predicts the class memberships for a given instance. If an instance is unclassified, the returned array elements + * will be all zero. * - * Smoothing is being implemented by the AttributeClassObserver classes. At - * the moment, the GaussianNumericProbabilityAttributeClassObserver needs no - * smoothing as it processes continuous variables. + * Smoothing is being implemented by the AttributeClassObserver classes. At the moment, the + * GaussianNumericProbabilityAttributeClassObserver needs no smoothing as it processes continuous variables. * - * Please note that we transform the scores to log space to avoid underflow, - * and we replace the multiplication with addition. + * Please note that we transform the scores to log space to avoid underflow, and we replace the multiplication with + * addition. * - * The resulting scores are no longer probabilities, as a mixture of - * probability densities and probabilities can be used in the computation. + * The resulting scores are no longer probabilities, as a mixture of probability densities and probabilities can be + * used in the computation. * * @param inst * the instance to be classified - * @return an array containing the estimated membership scores of the test - * instance in each class, in log space. + * @return an array containing the estimated membership scores of the test instance in each class, in log space. */ @Override public double[] getVotesForInstance(Instance inst) { @@ -184,8 +181,7 @@ public class NaiveBayes implements LocalLearner { } /** - * Resets this classifier. It must be similar to starting a new classifier - * from scratch. + * Resets this classifier. It must be similar to starting a new classifier from scratch. */ @Override public void resetLearning() { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/SimpleClassifierAdapter.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/SimpleClassifierAdapter.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/SimpleClassifierAdapter.java index 75c5284..e15aae0 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/SimpleClassifierAdapter.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/SimpleClassifierAdapter.java @@ -121,13 +121,12 @@ public class SimpleClassifierAdapter implements LocalLearner, Configurable { } /** - * Predicts the class memberships for a given instance. If an instance is - * unclassified, the returned array elements must be all zero. + * Predicts the class memberships for a given instance. If an instance is unclassified, the returned array elements + * must be all zero. * * @param inst * the instance to be classified - * @return an array containing the estimated membership probabilities of the - * test instance in each class + * @return an array containing the estimated membership probabilities of the test instance in each class */ @Override public double[] getVotesForInstance(Instance inst) { @@ -142,8 +141,7 @@ public class SimpleClassifierAdapter implements LocalLearner, Configurable { } /** - * Resets this classifier. It must be similar to starting a new classifier - * from scratch. + * Resets this classifier. It must be similar to starting a new classifier from scratch. * */ @Override http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/AMRulesRegressor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/AMRulesRegressor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/AMRulesRegressor.java index a05772b..fc49ebe 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/AMRulesRegressor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/AMRulesRegressor.java @@ -39,9 +39,8 @@ import com.yahoo.labs.samoa.topology.Stream; import com.yahoo.labs.samoa.topology.TopologyBuilder; /** - * AMRules Regressor is the task for the serialized implementation of AMRules - * algorithm for regression rule. It is adapted to SAMOA from the implementation - * of AMRules in MOA. + * AMRules Regressor is the task for the serialized implementation of AMRules algorithm for regression rule. It is + * adapted to SAMOA from the implementation of AMRules in MOA. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/HorizontalAMRulesRegressor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/HorizontalAMRulesRegressor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/HorizontalAMRulesRegressor.java index 9d4c5e6..f7038d3 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/HorizontalAMRulesRegressor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/HorizontalAMRulesRegressor.java @@ -40,9 +40,8 @@ import com.yahoo.labs.samoa.topology.Stream; import com.yahoo.labs.samoa.topology.TopologyBuilder; /** - * Horizontal AMRules Regressor is a distributed learner for regression rules - * learner. It applies both horizontal parallelism (dividing incoming streams) - * and vertical parallelism on AMRules algorithm. + * Horizontal AMRules Regressor is a distributed learner for regression rules learner. It applies both horizontal + * parallelism (dividing incoming streams) and vertical parallelism on AMRules algorithm. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/VerticalAMRulesRegressor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/VerticalAMRulesRegressor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/VerticalAMRulesRegressor.java index 131f086..01c72e5 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/VerticalAMRulesRegressor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/VerticalAMRulesRegressor.java @@ -38,8 +38,8 @@ import com.yahoo.labs.samoa.topology.Stream; import com.yahoo.labs.samoa.topology.TopologyBuilder; /** - * Vertical AMRules Regressor is a distributed learner for regression rules - * learner. It applies vertical parallelism on AMRules regressor. + * Vertical AMRules Regressor is a distributed learner for regression rules learner. It applies vertical parallelism on + * AMRules regressor. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/centralized/AMRulesRegressorProcessor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/centralized/AMRulesRegressorProcessor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/centralized/AMRulesRegressorProcessor.java index 48e9dbb..4bdd5c0 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/centralized/AMRulesRegressorProcessor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/centralized/AMRulesRegressorProcessor.java @@ -38,8 +38,8 @@ import com.yahoo.labs.samoa.moa.classifiers.rules.core.voting.ErrorWeightedVote; import com.yahoo.labs.samoa.topology.Stream; /** - * AMRules Regressor Processor is the main (and only) processor for - * AMRulesRegressor task. It is adapted from the AMRules implementation in MOA. + * AMRules Regressor Processor is the main (and only) processor for AMRulesRegressor task. It is adapted from the + * AMRules implementation in MOA. * * @author Anh Thu Vu * @@ -138,15 +138,13 @@ public class AMRulesRegressorProcessor implements Processor { } /** - * Helper method to generate new ResultContentEvent based on an instance and - * its prediction result. + * Helper method to generate new ResultContentEvent based on an instance and its prediction result. * * @param prediction * The predicted class label from the decision tree model. * @param inEvent * The associated instance content event - * @return ResultContentEvent to be sent into Evaluator PI or other - * destination PI. + * @return ResultContentEvent to be sent into Evaluator PI or other destination PI. */ private ResultContentEvent newResultContentEvent(double[] prediction, InstanceContentEvent inEvent) { ResultContentEvent rce = new ResultContentEvent(inEvent.getInstanceIndex(), inEvent.getInstance(), @@ -157,9 +155,8 @@ public class AMRulesRegressorProcessor implements Processor { } /** - * getVotesForInstance extension of the instance method getVotesForInstance in - * moa.classifier.java returns the prediction of the instance. Called in - * EvaluateModelRegression + * getVotesForInstance extension of the instance method getVotesForInstance in moa.classifier.java returns the + * prediction of the instance. Called in EvaluateModelRegression */ private double[] getVotesForInstance(Instance instance) { ErrorWeightedVote errorWeightedVote = newErrorWeightedVote(); @@ -199,18 +196,29 @@ public class AMRulesRegressorProcessor implements Processor { } public void trainOnInstanceImpl(Instance instance) { - /** - * AMRules Algorithm - * - * //For each rule in the rule set //If rule covers the instance //if the - * instance is not an anomaly //Update Change Detection Tests //Compute - * prediction error //Call PHTest //If change is detected then //Remove rule - * //Else //Update sufficient statistics of rule //If number of examples in - * rule > Nmin //Expand rule //If ordered set then //break //If none of the - * rule covers the instance //Update sufficient statistics of default rule - * //If number of examples in default rule is multiple of Nmin //Expand - * default rule and add it to the set of rules //Reset the default rule - */ + /* + AMRules Algorithm + + For each rule in the rule set + If rule covers the instance + if the instance is not an anomaly + Update Change Detection Tests + Compute prediction error + Call PHTest + If change is detected then + Remove rule + Else + Update sufficient statistics of rule + If number of examples in rule > Nmin + Expand rule + If ordered set then + break + If none of the rule covers the instance + Update sufficient statistics of default rule + If number of examples in default rule is multiple of Nmin + Expand default rule and add it to the set of rules + Reset the default rule + */ boolean rulesCoveringInstance = false; Iterator<ActiveRule> ruleIterator = this.ruleSet.iterator(); while (ruleIterator.hasNext()) { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/ActiveRule.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/ActiveRule.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/ActiveRule.java index 5d02079..0af17e9 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/ActiveRule.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/ActiveRule.java @@ -28,8 +28,7 @@ import com.yahoo.labs.samoa.moa.classifiers.rules.core.attributeclassobservers.F import com.yahoo.labs.samoa.moa.classifiers.rules.core.conditionaltests.NumericAttributeBinaryRulePredicate; /** - * ActiveRule is a LearningRule that actively update its LearningNode with - * incoming instances. + * ActiveRule is a LearningRule that actively update its LearningNode with incoming instances. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/PassiveRule.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/PassiveRule.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/PassiveRule.java index f49d0d9..96e2086 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/PassiveRule.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/PassiveRule.java @@ -23,8 +23,7 @@ package com.yahoo.labs.samoa.learners.classifiers.rules.common; import java.util.LinkedList; /** - * PassiveRule is a LearningRule that update its LearningNode with the received - * new LearningNode. + * PassiveRule is a LearningRule that update its LearningNode with the received new LearningNode. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Perceptron.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Perceptron.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Perceptron.java index 463dcdf..f459b64 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Perceptron.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Perceptron.java @@ -33,8 +33,7 @@ import com.yahoo.labs.samoa.moa.core.DoubleVector; import com.yahoo.labs.samoa.moa.core.Measurement; /** - * Prediction scheme using Perceptron: Predictions are computed according to a - * linear function of the attributes. + * Prediction scheme using Perceptron: Predictions are computed according to a linear function of the attributes. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Rule.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Rule.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Rule.java index 0f58559..76edd19 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Rule.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/Rule.java @@ -28,8 +28,7 @@ import com.yahoo.labs.samoa.moa.AbstractMOAObject; import com.yahoo.labs.samoa.moa.classifiers.rules.core.conditionaltests.NumericAttributeBinaryRulePredicate; /** - * The base class for "rule". Represents the most basic rule with and ID and a - * list of features (nodeList). + * The base class for "rule". Represents the most basic rule with and ID and a list of features (nodeList). * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveLearningNode.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveLearningNode.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveLearningNode.java index 513340e..725a765 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveLearningNode.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveLearningNode.java @@ -21,8 +21,7 @@ package com.yahoo.labs.samoa.learners.classifiers.rules.common; */ /** - * Interface for Rule's LearningNode that updates both statistics for expanding - * rule and computing predictions. + * Interface for Rule's LearningNode that updates both statistics for expanding rule and computing predictions. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveRegressionNode.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveRegressionNode.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveRegressionNode.java index 48daf7a..3fc7ad8 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveRegressionNode.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleActiveRegressionNode.java @@ -37,8 +37,7 @@ import com.yahoo.labs.samoa.moa.classifiers.rules.driftdetection.PageHinkleyFadi import com.yahoo.labs.samoa.moa.classifiers.rules.driftdetection.PageHinkleyTest; /** - * LearningNode for regression rule that updates both statistics for expanding - * rule and computing predictions. + * LearningNode for regression rule that updates both statistics for expanding rule and computing predictions. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveLearningNode.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveLearningNode.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveLearningNode.java index 5bc47f5..847482f 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveLearningNode.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveLearningNode.java @@ -21,8 +21,8 @@ package com.yahoo.labs.samoa.learners.classifiers.rules.common; */ /** - * Interface for Rule's LearningNode that does not update statistics for - * expanding rule. It only updates statistics for computing predictions. + * Interface for Rule's LearningNode that does not update statistics for expanding rule. It only updates statistics for + * computing predictions. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveRegressionNode.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveRegressionNode.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveRegressionNode.java index 086c9e1..1fe2db1 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveRegressionNode.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RulePassiveRegressionNode.java @@ -24,8 +24,8 @@ import com.yahoo.labs.samoa.instances.Instance; import com.yahoo.labs.samoa.moa.core.DoubleVector; /** - * LearningNode for regression rule that does not update statistics for - * expanding rule. It only updates statistics for computing predictions. + * LearningNode for regression rule that does not update statistics for expanding rule. It only updates statistics for + * computing predictions. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleRegressionNode.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleRegressionNode.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleRegressionNode.java index 068957d..e73d94f 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleRegressionNode.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/common/RuleRegressionNode.java @@ -281,8 +281,7 @@ public abstract class RuleRegressionNode implements Serializable { } /** - * Gets the index of the attribute in the instance, given the index of the - * attribute in the learner. + * Gets the index of the attribute in the instance, given the index of the attribute in the learner. * * @param index * the index of the attribute in the learner http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/AMRulesAggregatorProcessor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/AMRulesAggregatorProcessor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/AMRulesAggregatorProcessor.java index 5cb4f01..3e3df01 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/AMRulesAggregatorProcessor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/AMRulesAggregatorProcessor.java @@ -214,15 +214,13 @@ public class AMRulesAggregatorProcessor implements Processor { } /** - * Helper method to generate new ResultContentEvent based on an instance and - * its prediction result. + * Helper method to generate new ResultContentEvent based on an instance and its prediction result. * * @param prediction * The predicted class label from the decision tree model. * @param inEvent * The associated instance content event - * @return ResultContentEvent to be sent into Evaluator PI or other - * destination PI. + * @return ResultContentEvent to be sent into Evaluator PI or other destination PI. */ private ResultContentEvent newResultContentEvent(double[] prediction, InstanceContentEvent inEvent) { ResultContentEvent rce = new ResultContentEvent(inEvent.getInstanceIndex(), inEvent.getInstance(), http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/RuleContentEvent.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/RuleContentEvent.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/RuleContentEvent.java index ac7aced..19f7e46 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/RuleContentEvent.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/rules/distributed/RuleContentEvent.java @@ -24,8 +24,7 @@ import com.yahoo.labs.samoa.core.ContentEvent; import com.yahoo.labs.samoa.learners.classifiers.rules.common.ActiveRule; /** - * New rule from Model Aggregator/Default Rule Learner to Learners or removed - * rule from Learner to Model Aggregators. + * New rule from Model Aggregator/Default Rule Learner to Learners or removed rule from Learner to Model Aggregators. * * @author Anh Thu Vu * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeBatchContentEvent.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeBatchContentEvent.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeBatchContentEvent.java index c67efcb..5a617f0 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeBatchContentEvent.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeBatchContentEvent.java @@ -25,8 +25,7 @@ import java.util.LinkedList; import java.util.List; /** - * Attribute Content Event represents the instances that split vertically based - * on their attribute + * Attribute Content Event represents the instances that split vertically based on their attribute * * @author Arinto Murdopo * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeContentEvent.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeContentEvent.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeContentEvent.java index ca45d30..2b833f8 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeContentEvent.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/AttributeContentEvent.java @@ -28,8 +28,7 @@ import com.esotericsoftware.kryo.io.Output; import com.yahoo.labs.samoa.core.ContentEvent; /** - * Attribute Content Event represents the instances that split vertically based - * on their attribute + * Attribute Content Event represents the instances that split vertically based on their attribute * * @author Arinto Murdopo * @@ -157,8 +156,8 @@ public final class AttributeContentEvent implements ContentEvent { } /** - * The Kryo serializer class for AttributeContentEvent when executing on top - * of Storm. This class allow us to change the precision of the statistics. + * The Kryo serializer class for AttributeContentEvent when executing on top of Storm. This class allow us to change + * the precision of the statistics. * * @author Arinto Murdopo * @@ -191,8 +190,8 @@ public final class AttributeContentEvent implements ContentEvent { } /** - * The Kryo serializer class for AttributeContentEvent when executing on top - * of Storm with full precision of the statistics. + * The Kryo serializer class for AttributeContentEvent when executing on top of Storm with full precision of the + * statistics. * * @author Arinto Murdopo * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ComputeContentEvent.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ComputeContentEvent.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ComputeContentEvent.java index 8113a41..e6fe6c4 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ComputeContentEvent.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ComputeContentEvent.java @@ -26,9 +26,8 @@ import com.esotericsoftware.kryo.io.Input; import com.esotericsoftware.kryo.io.Output; /** - * Compute content event is the message that is sent by Model Aggregator - * Processor to request Local Statistic PI to start the local statistic - * calculation for splitting + * Compute content event is the message that is sent by Model Aggregator Processor to request Local Statistic PI to + * start the local statistic calculation for splitting * * @author Arinto Murdopo * @@ -67,8 +66,8 @@ public final class ComputeContentEvent extends ControlContentEvent { } /** - * The Kryo serializer class for ComputeContentEevent when executing on top of - * Storm. This class allow us to change the precision of the statistics. + * The Kryo serializer class for ComputeContentEevent when executing on top of Storm. This class allow us to change + * the precision of the statistics. * * @author Arinto Murdopo * @@ -106,8 +105,8 @@ public final class ComputeContentEvent extends ControlContentEvent { } /** - * The Kryo serializer class for ComputeContentEevent when executing on top of - * Storm with full precision of the statistics. + * The Kryo serializer class for ComputeContentEevent when executing on top of Storm with full precision of the + * statistics. * * @author Arinto Murdopo * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ControlContentEvent.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ControlContentEvent.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ControlContentEvent.java index e7b8653..409f531 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ControlContentEvent.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ControlContentEvent.java @@ -23,8 +23,7 @@ package com.yahoo.labs.samoa.learners.classifiers.trees; import com.yahoo.labs.samoa.core.ContentEvent; /** - * Abstract class to represent ContentEvent to control Local Statistic - * Processor. + * Abstract class to represent ContentEvent to control Local Statistic Processor. * * @author Arinto Murdopo * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/DeleteContentEvent.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/DeleteContentEvent.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/DeleteContentEvent.java index 52631bd..d21e3f0 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/DeleteContentEvent.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/DeleteContentEvent.java @@ -21,8 +21,8 @@ package com.yahoo.labs.samoa.learners.classifiers.trees; */ /** - * Delete Content Event is the content event that is sent by Model Aggregator - * Processor to delete unnecessary statistic in Local Statistic Processor. + * Delete Content Event is the content event that is sent by Model Aggregator Processor to delete unnecessary statistic + * in Local Statistic Processor. * * @author Arinto Murdopo * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FilterProcessor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FilterProcessor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FilterProcessor.java index d7f2cae..638e615 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FilterProcessor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FilterProcessor.java @@ -36,8 +36,7 @@ import java.util.LinkedList; import java.util.List; /** - * Filter Processor that stores and filters the instances before sending them to - * the Model Aggregator Processor. + * Filter Processor that stores and filters the instances before sending them to the Model Aggregator Processor. * * @author Arinto Murdopo * @@ -133,15 +132,13 @@ final class FilterProcessor implements Processor { } /** - * Helper method to generate new ResultContentEvent based on an instance and - * its prediction result. + * Helper method to generate new ResultContentEvent based on an instance and its prediction result. * * @param prediction * The predicted class label from the decision tree model. * @param inEvent * The associated instance content event - * @return ResultContentEvent to be sent into Evaluator PI or other - * destination PI. + * @return ResultContentEvent to be sent into Evaluator PI or other destination PI. */ private ResultContentEvent newResultContentEvent(double[] prediction, InstanceContentEvent inEvent) { ResultContentEvent rce = new ResultContentEvent(inEvent.getInstanceIndex(), inEvent.getInstance(), http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FoundNode.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FoundNode.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FoundNode.java index ba1c602..4b115f8 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FoundNode.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/FoundNode.java @@ -21,8 +21,8 @@ package com.yahoo.labs.samoa.learners.classifiers.trees; */ /** - * Class that represents the necessary data structure of the node where an - * instance is routed/filtered through the decision tree model. + * Class that represents the necessary data structure of the node where an instance is routed/filtered through the + * decision tree model. * * @author Arinto Murdopo * @@ -45,8 +45,8 @@ final class FoundNode implements java.io.Serializable { } /** - * Method to get the node where an instance is routed/filtered through the - * decision tree model for testing and training. + * Method to get the node where an instance is routed/filtered through the decision tree model for testing and + * training. * * @return The node where the instance is routed/filtered */ @@ -55,8 +55,8 @@ final class FoundNode implements java.io.Serializable { } /** - * Method to get the parent of the node where an instance is routed/filtered - * through the decision tree model for testing and training + * Method to get the parent of the node where an instance is routed/filtered through the decision tree model for + * testing and training * * @return The parent of the node */ @@ -65,8 +65,8 @@ final class FoundNode implements java.io.Serializable { } /** - * Method to get the index of the node (where an instance is routed/filtered - * through the decision tree model for testing and training) in its parent. + * Method to get the index of the node (where an instance is routed/filtered through the decision tree model for + * testing and training) in its parent. * * @return The index of the node in its parent node. */ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/InactiveLearningNode.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/InactiveLearningNode.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/InactiveLearningNode.java index d979d1b..40455bf 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/InactiveLearningNode.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/InactiveLearningNode.java @@ -23,9 +23,8 @@ package com.yahoo.labs.samoa.learners.classifiers.trees; import com.yahoo.labs.samoa.instances.Instance; /** - * Class that represents inactive learning node. Inactive learning node is a - * node which only keeps track of the observed class distribution. It does not - * store the statistic for splitting the node. + * Class that represents inactive learning node. Inactive learning node is a node which only keeps track of the observed + * class distribution. It does not store the statistic for splitting the node. * * @author Arinto Murdopo * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalResultContentEvent.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalResultContentEvent.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalResultContentEvent.java index 10ea055..52cd7fc 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalResultContentEvent.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalResultContentEvent.java @@ -24,8 +24,8 @@ import com.yahoo.labs.samoa.moa.classifiers.core.AttributeSplitSuggestion; import com.yahoo.labs.samoa.core.ContentEvent; /** - * Local Result Content Event is the content event that represents local - * calculation of statistic in Local Statistic Processor. + * Local Result Content Event is the content event that represents local calculation of statistic in Local Statistic + * Processor. * * @author Arinto Murdopo * @@ -56,8 +56,7 @@ final class LocalResultContentEvent implements ContentEvent { } /** - * Method to return the best attribute split suggestion from this local - * statistic calculation. + * Method to return the best attribute split suggestion from this local statistic calculation. * * @return The best attribute split suggestion. */ @@ -66,8 +65,7 @@ final class LocalResultContentEvent implements ContentEvent { } /** - * Method to return the second best attribute split suggestion from this local - * statistic calculation. + * Method to return the second best attribute split suggestion from this local statistic calculation. * * @return The second best attribute split suggestion. */ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalStatisticsProcessor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalStatisticsProcessor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalStatisticsProcessor.java index a6335e7..b133677 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalStatisticsProcessor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/LocalStatisticsProcessor.java @@ -44,8 +44,7 @@ import com.yahoo.labs.samoa.core.Processor; import com.yahoo.labs.samoa.topology.Stream; /** - * Local Statistic Processor contains the local statistic of a subset of the - * attributes. + * Local Statistic Processor contains the local statistic of a subset of the attributes. * * @author Arinto Murdopo * @@ -179,8 +178,7 @@ final class LocalStatisticsProcessor implements Processor { } /** - * Method to set the computation result when using this processor to build a - * topology. + * Method to set the computation result when using this processor to build a topology. * * @param computeStream */ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ModelAggregatorProcessor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ModelAggregatorProcessor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ModelAggregatorProcessor.java index b526a40..87ebe34 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ModelAggregatorProcessor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/ModelAggregatorProcessor.java @@ -53,14 +53,12 @@ import com.yahoo.labs.samoa.topology.Stream; import static com.yahoo.labs.samoa.moa.core.Utils.maxIndex; /** - * Model Aggegator Processor consists of the decision tree model. It connects to - * local-statistic PI via attribute stream and control stream. Model-aggregator - * PI sends the split instances via attribute stream and it sends control - * messages to ask local-statistic PI to perform computation via control stream. + * Model Aggegator Processor consists of the decision tree model. It connects to local-statistic PI via attribute stream + * and control stream. Model-aggregator PI sends the split instances via attribute stream and it sends control messages + * to ask local-statistic PI to perform computation via control stream. * - * Model-aggregator PI sends the classification result via result stream to an - * evaluator PI for classifier or other destination PI. The calculation results - * from local statistic arrive to the model-aggregator PI via computation-result + * Model-aggregator PI sends the classification result via result stream to an evaluator PI for classifier or other + * destination PI. The calculation results from local statistic arrive to the model-aggregator PI via computation-result * stream. * * @author Arinto Murdopo @@ -250,15 +248,13 @@ final class ModelAggregatorProcessor implements Processor { } /** - * Helper method to generate new ResultContentEvent based on an instance and - * its prediction result. + * Helper method to generate new ResultContentEvent based on an instance and its prediction result. * * @param prediction * The predicted class label from the decision tree model. * @param inEvent * The associated instance content event - * @return ResultContentEvent to be sent into Evaluator PI or other - * destination PI. + * @return ResultContentEvent to be sent into Evaluator PI or other destination PI. */ private ResultContentEvent newResultContentEvent(double[] prediction, InstanceContentEvent inEvent) { ResultContentEvent rce = new ResultContentEvent(inEvent.getInstanceIndex(), inEvent.getInstance(), @@ -383,8 +379,7 @@ final class ModelAggregatorProcessor implements Processor { } /** - * Helper method to get the prediction result. The actual prediction result is - * delegated to the leaf node. + * Helper method to get the prediction result. The actual prediction result is delegated to the leaf node. * * @param inst * @return @@ -423,9 +418,8 @@ final class ModelAggregatorProcessor implements Processor { } /** - * Helper method that represent training of an instance. Since it is decision - * tree, this method routes the incoming instance into the correct leaf and - * then update the statistic on the found leaf. + * Helper method that represent training of an instance. Since it is decision tree, this method routes the incoming + * instance into the correct leaf and then update the statistic on the found leaf. * * @param inst */ @@ -465,8 +459,7 @@ final class ModelAggregatorProcessor implements Processor { * @param activeLearningNode * The corresponding active learning node which will be split * @param foundNode - * The data structure to represents the filtering of the instance - * using the tree model. + * The data structure to represents the filtering of the instance using the tree model. */ private void attemptToSplit(ActiveLearningNode activeLearningNode, FoundNode foundNode) { // Increment the split ID @@ -489,14 +482,12 @@ final class ModelAggregatorProcessor implements Processor { } /** - * Helper method to continue the attempt to split once all local calculation - * results are received. + * Helper method to continue the attempt to split once all local calculation results are received. * * @param activeLearningNode * The corresponding active learning node which will be split * @param foundNode - * The data structure to represents the filtering of the instance - * using the tree model. + * The data structure to represents the filtering of the instance using the tree model. */ private void continueAttemptToSplit(ActiveLearningNode activeLearningNode, FoundNode foundNode) { AttributeSplitSuggestion bestSuggestion = activeLearningNode.getDistributedBestSuggestion(); @@ -600,8 +591,7 @@ final class ModelAggregatorProcessor implements Processor { } /** - * Helper method to set the model context, i.e. how many attributes they are - * and what is the class index + * Helper method to set the model context, i.e. how many attributes they are and what is the class index * * @param ih */ @@ -622,8 +612,8 @@ final class ModelAggregatorProcessor implements Processor { } /** - * AggregationTimeOutHandler is a class to support time-out feature while - * waiting for local computation results from the local statistic PIs. + * AggregationTimeOutHandler is a class to support time-out feature while waiting for local computation results from + * the local statistic PIs. * * @author Arinto Murdopo * @@ -652,8 +642,7 @@ final class ModelAggregatorProcessor implements Processor { } /** - * SplittingNodeInfo is a class to represents the ActiveLearningNode that is - * splitting + * SplittingNodeInfo is a class to represents the ActiveLearningNode that is splitting * * @author Arinto Murdopo * http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/Node.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/Node.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/Node.java index 22e551f..07f43d8 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/Node.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/Node.java @@ -36,8 +36,7 @@ abstract class Node implements java.io.Serializable { protected final DoubleVector observedClassDistribution; /** - * Method to route/filter an instance into its corresponding leaf. This method - * will be invoked recursively. + * Method to route/filter an instance into its corresponding leaf. This method will be invoked recursively. * * @param inst * Instance to be routed @@ -45,14 +44,12 @@ abstract class Node implements java.io.Serializable { * Parent of the current node * @param parentBranch * The index of the current node in the parent - * @return FoundNode which is the data structure to represent the resulting - * leaf. + * @return FoundNode which is the data structure to represent the resulting leaf. */ abstract FoundNode filterInstanceToLeaf(Instance inst, SplitNode parent, int parentBranch); /** - * Method to return the predicted class of the instance based on the statistic - * inside the node. + * Method to return the predicted class of the instance based on the statistic inside the node. * * @param inst * To-be-predicted instance @@ -89,8 +86,7 @@ abstract class Node implements java.io.Serializable { } /** - * A method to check whether the class distribution only consists of one class - * or not. + * A method to check whether the class distribution only consists of one class or not. * * @return Flag whether class distribution is pure or not. */ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/SplitNode.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/SplitNode.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/SplitNode.java index 7c6b434..6992852 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/SplitNode.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/SplitNode.java @@ -25,8 +25,8 @@ import com.yahoo.labs.samoa.moa.core.AutoExpandVector; import com.yahoo.labs.samoa.instances.Instance; /** - * SplitNode represents the node that contains one or more questions in the - * decision tree model, in order to route the instances into the correct leaf. + * SplitNode represents the node that contains one or more questions in the decision tree model, in order to route the + * instances into the correct leaf. * * @author Arinto Murdopo * @@ -78,8 +78,7 @@ public class SplitNode extends Node { } /** - * Method to set the children in a specific index of the SplitNode with the - * appropriate child + * Method to set the children in a specific index of the SplitNode with the appropriate child * * @param index * Index of the child in the SplitNode http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/VerticalHoeffdingTree.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/VerticalHoeffdingTree.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/VerticalHoeffdingTree.java index 990a15b..73b206b 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/VerticalHoeffdingTree.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/classifiers/trees/VerticalHoeffdingTree.java @@ -43,9 +43,8 @@ import com.yahoo.labs.samoa.topology.TopologyBuilder; /** * Vertical Hoeffding Tree. * <p/> - * Vertical Hoeffding Tree (VHT) classifier is a distributed classifier that - * utilizes vertical parallelism on top of Very Fast Decision Tree (VFDT) - * classifier. + * Vertical Hoeffding Tree (VHT) classifier is a distributed classifier that utilizes vertical parallelism on top of + * Very Fast Decision Tree (VFDT) classifier. * * @author Arinto Murdopo */
