Package ai.libs.jaicore.ml.dyadranking.algorithm.featuretransform

Class FeatureTransformPLDyadRanker

java.lang.Object

ai.libs.jaicore.ml.dyadranking.algorithm.featuretransform.FeatureTransformPLDyadRanker

All Implemented Interfaces:

IBatchLearner<IDyadRankingInstance,IDyadRankingInstance,DyadRankingDataset>, IPredictiveModel<IDyadRankingInstance,IDyadRankingInstance,DyadRankingDataset>, IDyadRanker, IPLDyadRanker

public class FeatureTransformPLDyadRanker
extends java.lang.Object
implements IPLDyadRanker

A feature transformation Placket-Luce dyad ranker. By default uses bilinear feature transformation. All the provided algorithms are implementations of the PLModel introduced in [1]. [1] Schäfer, D. & Hüllermeier, Dyad ranking using Plackett-Luce models based on joint feature representations, https://link.springer.com/article/10.1007%2Fs10994-017-5694-9

Constructor Summary

Constructors

Constructor	Description
FeatureTransformPLDyadRanker()	Constructs a new feature transform Placket-Luce dyad ranker with bilinear feature transformation.
FeatureTransformPLDyadRanker(IDyadFeatureTransform featureTransform)	Constructs a new feature transform Placket-Luce dyad ranker with the given feature transformation method.

Method Summary

Modifier and Type	Method	Description
IPredictiveModelConfiguration	getConfiguration()	Returns the IPredictiveModelConfiguration of this model.
java.util.List<IDyadRankingInstance>	predict(DyadRankingDataset dataset)	Performs multiple predictions based on the IInstances contained in the given AILabeledAttributeArrayDatasets and returns the result.
IDyadRankingInstance	predict(IDyadRankingInstance 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.
void	train(DyadRankingDataset dataset)	Trains this IBatchLearner using the given AILabeledAttributeArrayDataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureTransformPLDyadRanker

public FeatureTransformPLDyadRanker()

Constructs a new feature transform Placket-Luce dyad ranker with bilinear feature transformation.

FeatureTransformPLDyadRanker

public FeatureTransformPLDyadRanker(IDyadFeatureTransform featureTransform)

Constructs a new feature transform Placket-Luce dyad ranker with the given feature transformation method.

Parameters:

featureTransform - the feature transformation method to use

Method Detail

predict

public IDyadRankingInstance predict(IDyadRankingInstance instance)
                             throws PredictionException

Description copied from interface: IPredictiveModel

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

Specified by:

predict in interface IPredictiveModel<IDyadRankingInstance,IDyadRankingInstance,DyadRankingDataset>

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

public java.util.List<IDyadRankingInstance> predict(DyadRankingDataset dataset)
                                             throws PredictionException

Description copied from interface: IPredictiveModel

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

Specified by:

predict in interface IPredictiveModel<IDyadRankingInstance,IDyadRankingInstance,DyadRankingDataset>

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.

train

public void train(DyadRankingDataset dataset)
           throws TrainingException

Description copied from interface: IBatchLearner

Trains this IBatchLearner using the given AILabeledAttributeArrayDataset.

Specified by:

train in interface IBatchLearner<IDyadRankingInstance,IDyadRankingInstance,DyadRankingDataset>

Parameters:

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

Throws:

TrainingException - If something fails during the training process.

getConfiguration

public IPredictiveModelConfiguration getConfiguration()

Description copied from interface: IPredictiveModel

Returns the IPredictiveModelConfiguration of this model.

Specified by:

getConfiguration in interface IPredictiveModel<IDyadRankingInstance,IDyadRankingInstance,DyadRankingDataset>

Returns:

The IPredictiveModelConfiguration of this model.

setConfiguration

public void setConfiguration(IPredictiveModelConfiguration configuration)
                      throws ConfigurationException

Description copied from interface: IPredictiveModel

Sets the IPredictiveModelConfiguration of this model to the given one.

Specified by:

setConfiguration in interface IPredictiveModel<IDyadRankingInstance,IDyadRankingInstance,DyadRankingDataset>

Throws:

ConfigurationException - If something fails during the configuration process.