org.streaminer.stream.classifier

Class AbstractClassifier<D,C>

java.lang.Object

org.streaminer.stream.classifier.AbstractClassifier<D,C>

Type Parameters:

D - The data type of the input examples used for learning and prediction.

C - The label type, i.e. the Java class of the predicted outcome.

All Implemented Interfaces:

Serializable, Classifier<D,C>, Learner<D,PredictionModel<D,C>>, Model, PredictionModel<D,C>

Direct Known Subclasses:

AbstractMultiClassifier, MajorityClass, MultiRandomClassifier, NaiveBayes, NaiveBayesWOP, Perceptron, RandomClassifier

public abstract class AbstractClassifier<D,C>
extends Object
implements Classifier<D,C>

This class implements an abstract classifier, i.e. an instance that is capable of learning from observations of a specific, generic type D and predicting class values of type C.

Author:

Christian Bockermann <chris@jwall.org>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractClassifier()

Method Summary

Methods

Modifier and Type	Method and Description
PredictionModel<D,C>	getModel() Returns the result of the training process.
void	init() This method is called after the learner has been created and all parameters have been set.
abstract void	learn(D item) Starts or continues to train a model.
abstract C	predict(D item) This method returns a prediction for the given input.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractClassifier

public AbstractClassifier()

Method Detail

getModel

public final PredictionModel<D,C> getModel()

Description copied from interface: Learner

Returns the result of the training process.

Specified by:

getModel in interface Learner<D,PredictionModel<D,C>>

Returns:

Returns the current Model of the algorithm

See Also:

stream.learner.Learner#getModel()

init

public void init()

Description copied from interface: Learner

This method is called after the learner has been created and all parameters have been set.

Specified by:

init in interface Learner<D,PredictionModel<D,C>>

See Also:

stream.learner.Learner#init()

predict

public abstract C predict(D item)

Description copied from interface: PredictionModel

This method returns a prediction for the given input.

Specified by:

predict in interface PredictionModel<D,C>

Parameters:

item - to predict for

Returns:

a prediction for the given item

See Also:

stream.model.PredictionModel#predict(java.lang.Object)

learn

public abstract void learn(D item)

Description copied from interface: Learner

Starts or continues to train a model.

Specified by:

learn in interface Learner<D,PredictionModel<D,C>>

Parameters:

item - The input for the learning process

See Also:

stream.learner.Learner#learn(java.lang.Object)