net.myrrix.client.translating

Class TranslatingClientRecommender

java.lang.Object

net.myrrix.client.translating.TranslatingClientRecommender

All Implemented Interfaces:

TranslatingRecommender

public final class TranslatingClientRecommender
extends Object
implements TranslatingRecommender

Default implementation of TranslatingRecommender. It delegates to an underlying ClientRecommender which must be created and configured first.

Since:

1.0

Author:

Sean Owen

Constructor Summary

Constructors

Constructor and Description
TranslatingClientRecommender(ClientRecommender delegate)
TranslatingClientRecommender(ClientRecommender delegate, org.apache.mahout.cf.taste.model.IDMigrator userTranslator, MemoryIDMigrator itemTranslator)

Method Summary

Methods

Modifier and Type	Method and Description
void	addItemIDs(File idFile) Like TranslatingRecommender.addItemIDs(Iterable), but accepts a file containing item IDs, one per line.
void	addItemIDs(Iterable<String> ids) "Teaches" the client about item IDs, so that when the underlying recommender returns their hashed representation, this client can translate them back into true IDs.
void	await() Blocks indefinitely until TranslatingRecommender.isReady() returns true.
boolean	await(long time, TimeUnit unit) Blocks until TranslatingRecommender.isReady() returns true, or the given timeout is reached.
float	estimateForAnonymous(String toItemID, String[] itemIDs)
float	estimateForAnonymous(String toItemID, String[] itemIDs, float[] values)
float	estimatePreference(String userID, String itemID)
float[]	estimatePreferences(String userID, String... itemIDs)
Collection<String>	getAllItemIDs()
Collection<String>	getItemCluster(int n)
int	getNumItemClusters()
int	getNumUserClusters()
Collection<String>	getUserCluster(int n)
void	ingest(File file)
void	ingest(Reader reader)
boolean	isReady()
List<TranslatedRecommendedItem>	mostPopularItems(int howMany)
List<TranslatedRecommendedItem>	mostSimilarItems(String[] itemIDs, int howMany)
List<TranslatedRecommendedItem>	mostSimilarItems(String[] itemIDs, int howMany, String[] rescorerParams, String contextUserID)
List<TranslatedRecommendedItem>	mostSimilarItems(String itemID, int howMany)
List<TranslatedRecommendedItem>	recommend(String userID, int howMany)
List<TranslatedRecommendedItem>	recommend(String userID, int howMany, boolean considerKnownItems, String[] rescorerParams)
List<TranslatedRecommendedItem>	recommendedBecause(String userID, String itemID, int howMany)
List<TranslatedRecommendedItem>	recommendToAnonymous(String[] itemIDs, float[] values, int howMany)
List<TranslatedRecommendedItem>	recommendToAnonymous(String[] itemIDs, float[] values, int howMany, String[] rescorerParams, String contextUserID)
List<TranslatedRecommendedItem>	recommendToAnonymous(String[] itemIDs, int howMany)
List<TranslatedRecommendedItem>	recommendToMany(String[] userIDs, int howMany, boolean considerKnownItems, String[] rescorerParams)
void	refresh()
void	removePreference(String userID, String itemID)
void	setItemTag(String tag, String itemID)
void	setItemTag(String tag, String itemID, float value)
void	setPreference(String userID, String itemID)
void	setPreference(String userID, String itemID, float value)
void	setUserTag(String userID, String tag)
void	setUserTag(String userID, String tag, float value)
float[]	similarityToItem(String toItemID, String... itemIDs)
float[]	similarityToItem(String toItemID, String[] itemIDs, String contextUserID)

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslatingClientRecommender

public TranslatingClientRecommender(ClientRecommender delegate)

Parameters:

delegate - underlying ClientRecommender to use with translation

TranslatingClientRecommender

public TranslatingClientRecommender(ClientRecommender delegate,
                            org.apache.mahout.cf.taste.model.IDMigrator userTranslator,
                            MemoryIDMigrator itemTranslator)

Parameters:

delegate - underlying ClientRecommender to use with translation

userTranslator - IDMigrator that translates users (need not translate back), or null to disable user translation

itemTranslator - MemoryIDMigrator to use to translate items and back, or null to disable item translation

Method Detail

recommend

public List<TranslatedRecommendedItem> recommend(String userID,
                                        int howMany)
                                          throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

recommend in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.recommend(long, int)

recommend

public List<TranslatedRecommendedItem> recommend(String userID,
                                        int howMany,
                                        boolean considerKnownItems,
                                        String[] rescorerParams)
                                          throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

recommend in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

ClientRecommender.recommend(long, int, boolean, String[])

recommendToMany

public List<TranslatedRecommendedItem> recommendToMany(String[] userIDs,
                                              int howMany,
                                              boolean considerKnownItems,
                                              String[] rescorerParams)
                                                throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

recommendToMany in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

ClientRecommender.recommendToMany(long[], int, boolean, String[])

estimatePreference

public float estimatePreference(String userID,
                       String itemID)
                         throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

estimatePreference in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.estimatePreference(long, long)

estimatePreferences

public float[] estimatePreferences(String userID,
                          String... itemIDs)
                            throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

estimatePreferences in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.estimatePreferences(long, long...)

estimateForAnonymous

public float estimateForAnonymous(String toItemID,
                         String[] itemIDs)
                           throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

estimateForAnonymous in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.estimateForAnonymous(long, long[])

estimateForAnonymous

public float estimateForAnonymous(String toItemID,
                         String[] itemIDs,
                         float[] values)
                           throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

estimateForAnonymous in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.estimateForAnonymous(long, long[], float[])

setPreference

public void setPreference(String userID,
                 String itemID)
                   throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

setPreference in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.setPreference(long, long)

setPreference

public void setPreference(String userID,
                 String itemID,
                 float value)
                   throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

setPreference in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.setPreference(long, long, float)

removePreference

public void removePreference(String userID,
                    String itemID)
                      throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

removePreference in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.removePreference(long, long)

setUserTag

public void setUserTag(String userID,
              String tag)
                throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

setUserTag in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.setUserTag(long, String)

setUserTag

public void setUserTag(String userID,
              String tag,
              float value)
                throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

setUserTag in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.setUserTag(long, String, float)

setItemTag

public void setItemTag(String tag,
              String itemID)
                throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

setItemTag in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.setItemTag(String, long)

setItemTag

public void setItemTag(String tag,
              String itemID,
              float value)
                throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

setItemTag in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.setItemTag(String, long, float)

mostSimilarItems

public List<TranslatedRecommendedItem> mostSimilarItems(String itemID,
                                               int howMany)
                                                 throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

mostSimilarItems in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.mostSimilarItems(long, int)

mostSimilarItems

public List<TranslatedRecommendedItem> mostSimilarItems(String[] itemIDs,
                                               int howMany)
                                                 throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

mostSimilarItems in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.mostSimilarItems(long[], int)

mostSimilarItems

public List<TranslatedRecommendedItem> mostSimilarItems(String[] itemIDs,
                                               int howMany,
                                               String[] rescorerParams,
                                               String contextUserID)
                                                 throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

mostSimilarItems in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

ClientRecommender.mostSimilarItems(long[], int, String[], Long)

similarityToItem

public float[] similarityToItem(String toItemID,
                       String... itemIDs)
                         throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

similarityToItem in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

ClientRecommender.similarityToItem(long, long...)

similarityToItem

public float[] similarityToItem(String toItemID,
                       String[] itemIDs,
                       String contextUserID)
                         throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

similarityToItem in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

ClientRecommender.similarityToItem(long, long[], Long)

recommendedBecause

public List<TranslatedRecommendedItem> recommendedBecause(String userID,
                                                 String itemID,
                                                 int howMany)
                                                   throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

recommendedBecause in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.recommendedBecause(long, long, int)

recommendToAnonymous

public List<TranslatedRecommendedItem> recommendToAnonymous(String[] itemIDs,
                                                   int howMany)
                                                     throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

recommendToAnonymous in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.recommendToAnonymous(long[], int)

recommendToAnonymous

public List<TranslatedRecommendedItem> recommendToAnonymous(String[] itemIDs,
                                                   float[] values,
                                                   int howMany)
                                                     throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

recommendToAnonymous in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.recommendToAnonymous(long[], float[], int)

recommendToAnonymous

public List<TranslatedRecommendedItem> recommendToAnonymous(String[] itemIDs,
                                                   float[] values,
                                                   int howMany,
                                                   String[] rescorerParams,
                                                   String contextUserID)
                                                     throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

recommendToAnonymous in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

ClientRecommender.recommendToAnonymous(long[], float[], int, String[], Long)

mostPopularItems

public List<TranslatedRecommendedItem> mostPopularItems(int howMany)
                                                 throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

mostPopularItems in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.mostPopularItems(int)

ingest

public void ingest(Reader reader)
            throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

ingest in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.ingest(Reader)

ingest

public void ingest(File file)
            throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

ingest in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.ingest(File)

addItemIDs

public void addItemIDs(Iterable<String> ids)

Description copied from interface: TranslatingRecommender

"Teaches" the client about item IDs, so that when the underlying recommender returns their hashed representation, this client can translate them back into true IDs. The client must be told about all IDs it may need to return, using this method of TranslatingRecommender.addItemIDs(File).

Specified by:

addItemIDs in interface TranslatingRecommender

Parameters:

ids - item IDs that are in use by the system

addItemIDs

public void addItemIDs(File idFile)
                throws org.apache.mahout.cf.taste.common.TasteException

Description copied from interface: TranslatingRecommender

Like TranslatingRecommender.addItemIDs(Iterable), but accepts a file containing item IDs, one per line.

Specified by:

addItemIDs in interface TranslatingRecommender

Parameters:

idFile - file with one ID per line

Throws:

org.apache.mahout.cf.taste.common.TasteException

isReady

public boolean isReady()
                throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

isReady in interface TranslatingRecommender

Returns:

true if and only if the instance is ready to make recommendations; may be false for example while the recommender is still building an initial model

Throws:

org.apache.mahout.cf.taste.common.TasteException

refresh

public void refresh()

Specified by:

refresh in interface TranslatingRecommender

See Also:

MyrrixRecommender.refresh()

await

public void await()
           throws org.apache.mahout.cf.taste.common.TasteException,
                  InterruptedException

Description copied from interface: TranslatingRecommender

Blocks indefinitely until TranslatingRecommender.isReady() returns true.

Specified by:

await in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException - if an error occurs while checking TranslatingRecommender.isReady()

InterruptedException - if the thread is interrupted while waiting

await

public boolean await(long time,
            TimeUnit unit)
              throws org.apache.mahout.cf.taste.common.TasteException,
                     InterruptedException

Description copied from interface: TranslatingRecommender

Blocks until TranslatingRecommender.isReady() returns true, or the given timeout is reached.

Specified by:

await in interface TranslatingRecommender

Returns:

true if TranslatingRecommender.isReady() is true, or false if it timed out

Throws:

org.apache.mahout.cf.taste.common.TasteException - if an error occurs while checking TranslatingRecommender.isReady()

InterruptedException - if the thread is interrupted while waiting

getAllItemIDs

public Collection<String> getAllItemIDs()
                                 throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

getAllItemIDs in interface TranslatingRecommender

Returns:

all item IDs currently in the model

Throws:

org.apache.mahout.cf.taste.common.TasteException

getNumUserClusters

public int getNumUserClusters()
                       throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

getNumUserClusters in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.getNumUserClusters()

getNumItemClusters

public int getNumItemClusters()
                       throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

getNumItemClusters in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.getNumItemClusters()

getUserCluster

public Collection<String> getUserCluster(int n)
                                  throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

getUserCluster in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.getUserCluster(int)

getItemCluster

public Collection<String> getItemCluster(int n)
                                  throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

getItemCluster in interface TranslatingRecommender

Throws:

org.apache.mahout.cf.taste.common.TasteException

See Also:

MyrrixRecommender.getItemCluster(int)