net.myrrix.online.generation

Class Generation

java.lang.Object

net.myrrix.online.generation.Generation

public final class Generation
extends Object

Encapsulates one generation of the underlying recommender's model. The data in this object is quite specific to the underlying Alternating Least Squares algorithm. A generation contains:

• X, the user-feature matrix
• Y, the item-feature matrix
• XLeftInverse, X's left inverse
• YTRightInverse, the right inverse of Y transpose
• numFeatures, the column dimension of X and Y
• knownItemIDs, the item IDs already associated to each user
• itemTagIDs, IDs of "users" that are really item tags
• userTagIDs, IDs of "items" that are really user tags
• clusters of item IDs (in distributed mode), with centroids
• clusters of user IDs (in distributed mode), with centroids

Since:

1.0

Author:

Sean Owen

See Also:

MatrixFactorizer

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_KNOWN_ITEMS_KEY

Constructor Summary

Constructors

Constructor and Description
Generation(FastByIDMap<FastIDSet> knownItemIDs, FastByIDMap<float[]> X, FastByIDMap<float[]> Y)
Generation(FastByIDMap<FastIDSet> knownItemIDs, FastByIDMap<float[]> X, FastByIDMap<float[]> Y, FastIDSet itemTagIDs, FastIDSet userTagIDs)
Generation(FastByIDMap<FastIDSet> knownItemIDs, FastByIDMap<float[]> X, FastByIDMap<float[]> Y, FastIDSet itemTagIDs, FastIDSet userTagIDs, List<IDCluster> userClusters, List<IDCluster> itemClusters)

Method Summary

Methods

Modifier and Type	Method and Description
CandidateFilter	getCandidateFilter()
List<IDCluster>	getItemClusters()
ReadWriteLock	getItemClustersLock() Acquire this read/write lock before using getItemClusters().
FastIDSet	getItemTagIDs()
FastByIDMap<FastIDSet>	getKnownItemIDs()
ReadWriteLock	getKnownItemLock() Acquire this read/write lock before using getKnownItemIDs().
FastByIDMap<FastIDSet>	getKnownUserIDs() Not used, yet.
ReadWriteLock	getKnownUserLock() Not used, yet.
int	getNumItems()
int	getNumUsers()
List<IDCluster>	getUserClusters()
ReadWriteLock	getUserClustersLock() Acquire this read/write lock before using getUserClusters().
FastIDSet	getUserTagIDs()
FastByIDMap<float[]>	getX()
ReadWriteLock	getXLock() Acquire this read/write lock before using getX() or getItemTagIDs().
Solver	getXTXSolver()
FastByIDMap<float[]>	getY()
ReadWriteLock	getYLock() Acquire this read/write lock before using getY() or getUserTagIDs().
Solver	getYTYSolver()

Methods inherited from class java.lang.Object

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

Field Detail

NO_KNOWN_ITEMS_KEY

public static final String NO_KNOWN_ITEMS_KEY

See Also:

Constant Field Values

Constructor Detail

Generation

public Generation(FastByIDMap<FastIDSet> knownItemIDs,
          FastByIDMap<float[]> X,
          FastByIDMap<float[]> Y)

Generation

public Generation(FastByIDMap<FastIDSet> knownItemIDs,
          FastByIDMap<float[]> X,
          FastByIDMap<float[]> Y,
          FastIDSet itemTagIDs,
          FastIDSet userTagIDs)

Generation

public Generation(FastByIDMap<FastIDSet> knownItemIDs,
          FastByIDMap<float[]> X,
          FastByIDMap<float[]> Y,
          FastIDSet itemTagIDs,
          FastIDSet userTagIDs,
          List<IDCluster> userClusters,
          List<IDCluster> itemClusters)

Method Detail

getNumUsers

public int getNumUsers()

Returns:

the number of "users" in the model (rows of getX()

getNumItems

public int getNumItems()

Returns:

the number of "items" in the model (rows of getY()

getX

public FastByIDMap<float[]> getX()

Returns:

the user-feature matrix, implemented as a map from row number (user ID) to feature array

getXTXSolver

public Solver getXTXSolver()

Returns:

Solver for the matrix X' * X

getY

public FastByIDMap<float[]> getY()

Returns:

the item-feature matrix, implemented as a map from row number (item ID) to feature array

getYTYSolver

public Solver getYTYSolver()

Returns:

Solver for the matrix Y' * Y

getKnownItemIDs

public FastByIDMap<FastIDSet> getKnownItemIDs()

Returns:

the item IDs already associated to each user, as a map from user IDs to a set of item IDs

getKnownUserIDs

public FastByIDMap<FastIDSet> getKnownUserIDs()

Not used, yet.

Returns:

null

getItemTagIDs

public FastIDSet getItemTagIDs()

Returns:

"user" IDs which are actually item tags

getUserTagIDs

public FastIDSet getUserTagIDs()

Returns:

"item" IDs which are actually user tags

getUserClusters

public List<IDCluster> getUserClusters()

Returns:

clusters of user IDs, or null if not in distributed mode

getItemClusters

public List<IDCluster> getItemClusters()

Returns:

clusters of item IDs, or null if not in distributed mode

getCandidateFilter

public CandidateFilter getCandidateFilter()

getXLock

public ReadWriteLock getXLock()

Acquire this read/write lock before using getX() or getItemTagIDs().

getYLock

public ReadWriteLock getYLock()

Acquire this read/write lock before using getY() or getUserTagIDs().

getKnownItemLock

public ReadWriteLock getKnownItemLock()

Acquire this read/write lock before using getKnownItemIDs().

getKnownUserLock

public ReadWriteLock getKnownUserLock()

Not used, yet.

Returns:

null

getUserClustersLock

public ReadWriteLock getUserClustersLock()

Acquire this read/write lock before using getUserClusters().

getItemClustersLock

public ReadWriteLock getItemClustersLock()

Acquire this read/write lock before using getItemClusters().