Package ai.libs.jaicore.ml.ranking.dyad.learner.activelearning

Interface IDyadRankingPoolProvider

  • All Superinterfaces:
    org.api4.java.ai.ml.core.learner.active.IActiveLearningPoolProvider<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance>
    All Known Implementing Classes:
    DyadDatasetPoolProvider
    public interface IDyadRankingPoolProvider
extends org.api4.java.ai.ml.core.learner.active.IActiveLearningPoolProvider<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance>
    Interface for an active learning pool provider in the context of dyad ranking. It offers access to the pool of dyads both by instance features and alternative features.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Set<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad> getDyadsByAlternative​(org.api4.java.common.math.IVector alternativeFeatures)
      Returns the set of all Dyads with the given IVector of alternative features.
      java.util.Set<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad> getDyadsByInstance​(org.api4.java.common.math.IVector instanceFeatures)
      Returns the set of all Dyads with the given IVector of instance features.
      java.util.Collection<org.api4.java.common.math.IVector> getInstanceFeatures()
      Returns a Collection that contains all instance features contained in the pool.
      int getPoolSize()  
      DyadRankingDataset getQueriedRankings()  
      void setRemoveDyadsWhenQueried​(boolean flag)  

      • Methods inherited from interface org.api4.java.ai.ml.core.learner.active.IActiveLearningPoolProvider

        getPool, query

    • Method Detail

      • getDyadsByInstance

        java.util.Set<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad> getDyadsByInstance​(org.api4.java.common.math.IVector instanceFeatures)
        Returns the set of all Dyads with the given IVector of instance features.
        Parameters:
        instanceFeatures - IVector of instance features.
        Returns:
        Set of dyads with the given IVector of instance features.

      • getDyadsByAlternative

        java.util.Set<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad> getDyadsByAlternative​(org.api4.java.common.math.IVector alternativeFeatures)
        Returns the set of all Dyads with the given IVector of alternative features.
        Parameters:
        alternativeFeatures - IVector of alternative features.
        Returns:
        Set of dyads with the given IVector of alternative features.

      • getInstanceFeatures

        java.util.Collection<org.api4.java.common.math.IVector> getInstanceFeatures()
        Returns a Collection that contains all instance features contained in the pool.
        Returns:
        A Collection that contains all instance features contained in the pool.

      • setRemoveDyadsWhenQueried

        void setRemoveDyadsWhenQueried​(boolean flag)

      • getPoolSize

        int getPoolSize()