ai.libs.jaicore.ml.core.predictivemodel

Interface IPredictiveModel<TARGET>

Type Parameters:

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

All Known Subinterfaces:

IBatchLearner<TARGET>, IOnlineLearner<TARGET>

public interface IPredictiveModel<TARGET>

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

Method Summary

Modifier and Type	Method and Description
IPredictiveModelConfiguration	getConfiguration() Returns the IPredictiveModelConfiguration of this model.
java.util.List<TARGET>	predict(IDataset dataset) Performs multiple predictions based on the IInstances contained in the given IDatasets and returns the result.
TARGET	predict(IInstance 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

TARGET predict(IInstance 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<TARGET> predict(IDataset dataset)
                        throws PredictionException

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

Parameters:

dataset - The IDataset 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.