package jsat.classifiers;
import java.io.Serializable;
import jsat.exceptions.FailedToFitException;
import jsat.exceptions.ModelMismatchException;
import jsat.exceptions.UntrainedModelException;
/**
* A Classifier is used to predict the target class of new unseen data points.
*
* @author Edward Raff
*/
public interface Classifier extends Cloneable, Serializable
{
/**
* Performs classification on the given data point.
* @param data the data point to classify
* @return the results of the classification.
* @throws UntrainedModelException if the method is called before the model has been trained
* @throws ModelMismatchException if the given data point is incompatible with the model
*/
public CategoricalResults classify(DataPoint data);
/**
* Trains the classifier and constructs a model for classification using the
* given data set. If the training method knows how, it will used the
* threadPool to conduct training in parallel. This method will
* block until the training has completed.
*
* @param dataSet the data set to train on
* @param parallel {@code true} if multiple threads should be used to train
* the model. {@code false} if it should be done in a single threaded
* manner.
* @throws FailedToFitException if the model is unable to be constructed for some reason
*/
public void train(ClassificationDataSet dataSet, boolean parallel);
/**
* Trains the classifier and constructs a model for classification using the
* given data set.
*
* @param dataSet the data set to train on
* @throws FailedToFitException if the model is unable to be constructed for some reason
*/
default public void train(ClassificationDataSet dataSet)
{
Classifier.this.train(dataSet, false);
}
/**
* Indicates whether the model knows how to train using weighted data points. If it
* does, the model will train assuming the weights. The values returned by this
* method may change depending on the parameters set for the model.
* @return true if the model supports weighted data, false otherwise
*/
public boolean supportsWeightedData();
public Classifier clone();
}
Ads help maintain this website.