gov.sandia.cognition.learning.algorithm
Class AbstractBatchAndIncrementalLearner<DataType,ResultType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.algorithm.AbstractBatchAndIncrementalLearner<DataType,ResultType>
Type Parameters:
DataType - Type of the input data. Typically an iterable or a collection.
ResultType - Result type from both the online- and batch-learning interfaces.
All Implemented Interfaces:
BatchAndIncrementalLearner<DataType,ResultType>, BatchLearner<Collection<? extends DataType>,ResultType>, IncrementalLearner<DataType,ResultType>, CloneableSerializable, Serializable, Cloneable
Direct Known Subclasses:
AbstractConjugatePriorBayesianEstimator, AbstractIncrementalEstimator, AbstractKalmanFilter, AbstractParticleFilter, AbstractSupervisedBatchAndIncrementalLearner, DefaultDataDistribution.Estimator, DefaultDataDistribution.WeightedEstimator, OnlineMultiPerceptron, ScalarDataDistribution.Estimator, SimpleStatisticalSpellingCorrector.Learner, VectorNaiveBayesCategorizer.OnlineLearner

public abstract class AbstractBatchAndIncrementalLearner<DataType,ResultType>
extends AbstractCloneableSerializable
implements BatchAndIncrementalLearner<DataType,ResultType>

An abstract class that has both batch learning ability as well as online learning ability by taking a Collection of input data. For the batch learning case, we iterate over the Collection of input data and pass this through the online learning function to arrive at the batch result.

Since:
3.0
Author:
Kevin R. Dixon, Justin Basilico
See Also:
Serialized Form

Constructor Summary
AbstractBatchAndIncrementalLearner()
          Creates a new instance of AbstractBatchAndIncrementalLearner.
 
Method Summary
 AbstractBatchAndIncrementalLearner<DataType,ResultType> clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 ResultType learn(Collection<? extends DataType> data)
          The learn method creates an object of ResultType using data of type DataType, using some form of "learning" algorithm.
 ResultType learn(Iterable<? extends DataType> data)
          Creates an object of ResultType using data of type DataType, using some form of "learning" algorithm.
 void update(ResultType target, Iterable<? extends DataType> data)
          The update method updates an object of ResultType using the given new Iterable containing some number of type DataType, using some form of "learning" algorithm.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.learning.algorithm.IncrementalLearner
createInitialLearnedObject, update
 

Constructor Detail

AbstractBatchAndIncrementalLearner

public AbstractBatchAndIncrementalLearner()
Creates a new instance of AbstractBatchAndIncrementalLearner.

Method Detail

clone

public AbstractBatchAndIncrementalLearner<DataType,ResultType> clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

learn

public ResultType learn(Collection<? extends DataType> data)
Description copied from interface: BatchLearner
The learn method creates an object of ResultType using data of type DataType, using some form of "learning" algorithm.

Specified by:
learn in interface BatchLearner<Collection<? extends DataType>,ResultType>
Parameters:
data - The data that the learning algorithm will use to create an object of ResultType.
Returns:
The object that is created based on the given data using the learning algorithm.

learn

public ResultType learn(Iterable<? extends DataType> data)
Description copied from interface: BatchAndIncrementalLearner
Creates an object of ResultType using data of type DataType, using some form of "learning" algorithm. Typically implemented as a convenience method for calling an incremental learner on each data point.

Specified by:
learn in interface BatchAndIncrementalLearner<DataType,ResultType>
Parameters:
data - The data that the learning algorithm will use to create an object of ResultType.
Returns:
The object that is created based on the given data using the learning algorithm.

update

public void update(ResultType target,
                   Iterable<? extends DataType> data)
Description copied from interface: IncrementalLearner
The update method updates an object of ResultType using the given new Iterable containing some number of type DataType, using some form of "learning" algorithm.

Specified by:
update in interface IncrementalLearner<DataType,ResultType>
Parameters:
target - The object to update.
data - The Iterable containing data for the learning algorithm to use to update the object.