Package ai.libs.jaicore.ml.classification.singlelabel.timeseries.learner

Class ASimplifiedTSClassifier<T>

java.lang.Object

ai.libs.jaicore.ml.classification.singlelabel.timeseries.learner.ASimplifiedTSClassifier<T>

Direct Known Subclasses:

BOSSClassifier, BOSSEnsembleClassifier, NearestNeighborClassifier, ShotgunEnsembleClassifier

public abstract class ASimplifiedTSClassifier<T>
extends java.lang.Object

Simplified batch-learning time series classifier which can be trained and used as a predictor. Uses algorithm to train the model parameters (if necessary).

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassMapper	classMapper	Class mapper object used to encode and decode predicted values if String values are used as classes.
protected boolean	trained	Variable indicating whether the classifier has been trained.

Constructor Summary

Constructors

Constructor	Description
ASimplifiedTSClassifier()

Method Summary

Modifier and Type	Method	Description
protected double[][]	checkWhetherPredictionIsPossible(TimeSeriesDataset2 dataset)
ClassMapper	getClassMapper()	Getter for the property classMapper.
abstract <U extends ASimplifiedTSClassifier<T>> ASimplifiedTSCLearningAlgorithm<T,U>	getLearningAlgorithm(TimeSeriesDataset2 dataset)
boolean	isTrained()
abstract T	predict(double[] univInstance)	Performs a prediction based on the given univariate double[] instance representation and returns the result.
abstract java.util.List<T>	predict(TimeSeriesDataset2 dataset)	Performs predictions based on the given instances in the given dataset.
T	predict(java.util.List<double[]> multivInstance)	Performs a prediction based on the given multivariate list of double[] instance representation and returns the result.
void	setClassMapper(ClassMapper classMapper)	Setter for the property classMapper.
void	train(TimeSeriesDataset2 dataset)	Trains the simplified time series classifier model using the given TimeSeriesDataset2.

Methods inherited from class java.lang.Object

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

Field Detail

classMapper

protected ClassMapper classMapper

Class mapper object used to encode and decode predicted values if String values are used as classes. Can be null if the predicted values are not mapped to String values.

trained

protected boolean trained

Variable indicating whether the classifier has been trained.

Constructor Detail

ASimplifiedTSClassifier

public ASimplifiedTSClassifier()

Method Detail

predict

public abstract T predict(double[] univInstance)
                   throws org.api4.java.ai.ml.core.exception.PredictionException

Performs a prediction based on the given univariate double[] instance representation and returns the result.

Parameters:

univInstance - Univariate instance given by a double vector of time series values used for the prediction

Returns:

Returns the result of the prediction

Throws:

org.api4.java.ai.ml.core.exception.PredictionException - If something fails during the prediction process.

predict

public T predict(java.util.List<double[]> multivInstance)
          throws org.api4.java.ai.ml.core.exception.PredictionException

Performs a prediction based on the given multivariate list of double[] instance representation and returns the result.

Parameters:

multivInstance - Multivariate instance given by a list of multiple double[] time series used for the prediction

Returns:

Returns the result of the prediction

Throws:

org.api4.java.ai.ml.core.exception.PredictionException - If something fails during the prediction process.

predict

public abstract java.util.List<T> predict(TimeSeriesDataset2 dataset)
                                   throws org.api4.java.ai.ml.core.exception.PredictionException

Performs predictions based on the given instances in the given dataset.

Parameters:

dataset - The TimeSeriesDataset2 for which predictions should be made.

Returns:

Returns the result of the predictions

Throws:

org.api4.java.ai.ml.core.exception.PredictionException - If something fails during the prediction process

getLearningAlgorithm

public abstract <U extends ASimplifiedTSClassifier<T>> ASimplifiedTSCLearningAlgorithm<T,U> getLearningAlgorithm(TimeSeriesDataset2 dataset)

train

public final void train(TimeSeriesDataset2 dataset)
                 throws org.api4.java.ai.ml.core.exception.TrainingException

Trains the simplified time series classifier model using the given TimeSeriesDataset2.

Parameters:

dataset - The TimeSeriesDataset2 which should be used for the training.

Throws:

org.api4.java.ai.ml.core.exception.TrainingException - If something fails during the training process.

getClassMapper

public ClassMapper getClassMapper()

Getter for the property classMapper.

Returns:

Returns the actual class mapper or null if no mapper is stored

setClassMapper

public void setClassMapper(ClassMapper classMapper)

Setter for the property classMapper.

Parameters:

classMapper - The class mapper to be set

isTrained

public boolean isTrained()

Returns:

the trained

checkWhetherPredictionIsPossible

protected double[][] checkWhetherPredictionIsPossible(TimeSeriesDataset2 dataset)
                                               throws org.api4.java.ai.ml.core.exception.PredictionException

Throws:

org.api4.java.ai.ml.core.exception.PredictionException