Class FeatureTransformPLDyadRanker

  • All Implemented Interfaces:
    IDyadRanker, IPLDyadRanker, org.api4.java.ai.ml.core.learner.IFittable<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset>, org.api4.java.ai.ml.core.learner.IFittablePredictor<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset>, org.api4.java.ai.ml.core.learner.ILearnerConfigHandler, org.api4.java.ai.ml.core.learner.IPredictor<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset>, org.api4.java.ai.ml.core.learner.ISupervisedLearner<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset>, org.api4.java.ai.ml.ranking.learner.IRanker<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset>

    public class FeatureTransformPLDyadRanker
    extends ASupervisedLearner<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset,​org.api4.java.ai.ml.ranking.IRanking<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad>,​org.api4.java.ai.ml.ranking.IRankingPredictionBatch>
    implements IPLDyadRanker
    A feature transformation Plackett-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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void fit​(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset dataset)  
      org.api4.java.ai.ml.ranking.IRanking<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad> predict​(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance instance)  
      org.api4.java.ai.ml.ranking.IRankingPredictionBatch predict​(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance[] dTest)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface org.api4.java.ai.ml.core.learner.IFittablePredictor

        fitAndPredict, fitAndPredict, fitAndPredict
      • Methods inherited from interface org.api4.java.ai.ml.core.learner.ILearnerConfigHandler

        getConfig, setConfig
      • Methods inherited from interface org.api4.java.ai.ml.core.learner.IPredictor

        predict
    • 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

      • fit

        public void fit​(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset dataset)
                 throws org.api4.java.ai.ml.core.exception.TrainingException,
                        java.lang.InterruptedException
        Specified by:
        fit in interface org.api4.java.ai.ml.core.learner.IFittable<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset>
        Throws:
        org.api4.java.ai.ml.core.exception.TrainingException
        java.lang.InterruptedException
      • predict

        public org.api4.java.ai.ml.ranking.IRanking<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad> predict​(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance instance)
                                                                                                     throws org.api4.java.ai.ml.core.exception.PredictionException,
                                                                                                            java.lang.InterruptedException
        Specified by:
        predict in interface org.api4.java.ai.ml.core.learner.IPredictor<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset>
        Specified by:
        predict in interface org.api4.java.ai.ml.ranking.learner.IRanker<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset>
        Specified by:
        predict in class ASupervisedLearner<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset,​org.api4.java.ai.ml.ranking.IRanking<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad>,​org.api4.java.ai.ml.ranking.IRankingPredictionBatch>
        Throws:
        org.api4.java.ai.ml.core.exception.PredictionException
        java.lang.InterruptedException
      • predict

        public org.api4.java.ai.ml.ranking.IRankingPredictionBatch predict​(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance[] dTest)
                                                                    throws org.api4.java.ai.ml.core.exception.PredictionException,
                                                                           java.lang.InterruptedException
        Specified by:
        predict in interface org.api4.java.ai.ml.core.learner.IPredictor<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset>
        Specified by:
        predict in class ASupervisedLearner<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance,​org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset,​org.api4.java.ai.ml.ranking.IRanking<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad>,​org.api4.java.ai.ml.ranking.IRankingPredictionBatch>
        Throws:
        org.api4.java.ai.ml.core.exception.PredictionException
        java.lang.InterruptedException