Package ai.libs.jaicore.ml.core.predictivemodel

Interface IPredictiveModel<T,I,D extends IDataset<I>>

Type Parameters:

T - The type of the target that this IPredictiveModel predicts.

I - The type of the instances stored in the data set specified by the generic parameter .

D - The type of the data set used to learn from and predict batches.

All Known Subinterfaces:

IBatchLearner<T,I,D>, ICertaintyProvider<T,I,D>, IDyadRanker, IOnlineLearner<T,I,D>, IPLDyadRanker

All Known Implementing Classes:

ABatchLearner, AOnlineLearner, APredictiveModel, FeatureTransformPLDyadRanker, PLNetDyadRanker, TSClassifier

public interface IPredictiveModel<T,I,D extends IDataset<I>>

The IPredictiveModel corresponds to a model which can be used to make predictions based on given IInstancees.

Method Summary

Modifier and Type	Method	Description
IPredictiveModelConfiguration	getConfiguration()	Returns the IPredictiveModelConfiguration of this model.
java.util.List<T>	predict(D dataset)	Performs multiple predictions based on the IInstances contained in the given AILabeledAttributeArrayDatasets and returns the result.
T	predict(I instance)	Performs a prediction based on the given IInstance and returns the result.
void	setConfiguration(IPredictiveModelConfiguration configuration)	Sets the IPredictiveModelConfiguration of this model to the given one.

Method Detail

predict

T predict(I instance)
   throws PredictionException

Performs a prediction based on the given IInstance and returns the result.

Parameters:

instance - The IInstance for which a prediction should be made.

Returns:

The result of the prediction.

Throws:

PredictionException - If something fails during the prediction process.

predict

java.util.List<T> predict(D dataset)
                   throws PredictionException

Performs multiple predictions based on the IInstances contained in the given AILabeledAttributeArrayDatasets and returns the result.

Parameters:

dataset - The AILabeledAttributeArrayDataset for which predictions should be made.

Returns:

The result of the predictions.

Throws:

PredictionException - If something fails during the prediction process.

getConfiguration

IPredictiveModelConfiguration getConfiguration()

Returns the IPredictiveModelConfiguration of this model.

Returns:

The IPredictiveModelConfiguration of this model.

setConfiguration

void setConfiguration(IPredictiveModelConfiguration configuration)
               throws ConfigurationException

Sets the IPredictiveModelConfiguration of this model to the given one.

Throws:

ConfigurationException - If something fails during the configuration process.