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

Class DyadDatasetPoolProvider

java.lang.Object

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

All Implemented Interfaces:

IDyadRankingPoolProvider, org.api4.java.ai.ml.core.learner.active.IActiveLearningPoolProvider<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance>

public class DyadDatasetPoolProvider
extends java.lang.Object
implements IDyadRankingPoolProvider

A pool provider which is created out of a DyadRankingDataset. Each SparseDyadRankingInstance or DenseDyadRankingInstance of the DyadRankingDataset must represent a full ranking. Only queries of rankings over the same instance features can be answered.

Constructor Summary

Constructors

Constructor	Description
DyadDatasetPoolProvider(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset dataset)

Method Summary

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	getNumberQueries()	Returns the number of queries the pool provider has answered so far.
java.util.Collection<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance>	getPool()
int	getPoolSize()
DyadRankingDataset	getQueriedRankings()
org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance	query(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance queryInstance)
void	setRemoveDyadsWhenQueried(boolean flag)

Methods inherited from class java.lang.Object

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

Constructor Detail

DyadDatasetPoolProvider

public DyadDatasetPoolProvider(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingDataset dataset)

Method Detail

getPool

public java.util.Collection<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance> getPool()

Specified by:

getPool in interface org.api4.java.ai.ml.core.learner.active.IActiveLearningPoolProvider<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance>

query

public org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance query(org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance queryInstance)

Specified by:

query in interface org.api4.java.ai.ml.core.learner.active.IActiveLearningPoolProvider<org.api4.java.ai.ml.ranking.dyad.dataset.IDyadRankingInstance>

getDyadsByInstance

public java.util.Set<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad> getDyadsByInstance(org.api4.java.common.math.IVector instanceFeatures)

Description copied from interface: IDyadRankingPoolProvider

Returns the set of all Dyads with the given IVector of instance features.

Specified by:

getDyadsByInstance in interface IDyadRankingPoolProvider

Parameters:

instanceFeatures - IVector of instance features.

Returns:

Set of dyads with the given IVector of instance features.

getDyadsByAlternative

public java.util.Set<org.api4.java.ai.ml.ranking.dyad.dataset.IDyad> getDyadsByAlternative(org.api4.java.common.math.IVector alternativeFeatures)

Description copied from interface: IDyadRankingPoolProvider

Returns the set of all Dyads with the given IVector of alternative features.

Specified by:

getDyadsByAlternative in interface IDyadRankingPoolProvider

Parameters:

alternativeFeatures - IVector of alternative features.

Returns:

Set of dyads with the given IVector of alternative features.

getInstanceFeatures

public java.util.Collection<org.api4.java.common.math.IVector> getInstanceFeatures()

Description copied from interface: IDyadRankingPoolProvider

Returns a Collection that contains all instance features contained in the pool.

Specified by:

getInstanceFeatures in interface IDyadRankingPoolProvider

Returns:

A Collection that contains all instance features contained in the pool.

setRemoveDyadsWhenQueried

public void setRemoveDyadsWhenQueried(boolean flag)

Specified by:

setRemoveDyadsWhenQueried in interface IDyadRankingPoolProvider

getPoolSize

public int getPoolSize()

Specified by:

getPoolSize in interface IDyadRankingPoolProvider

getNumberQueries

public int getNumberQueries()

Returns the number of queries the pool provider has answered so far.

Returns:

Number of queries this pool provider has answered.

getQueriedRankings

public DyadRankingDataset getQueriedRankings()

Specified by:

getQueriedRankings in interface IDyadRankingPoolProvider