net.myrrix.client

Class ClientRecommender

java.lang.Object

net.myrrix.client.ClientRecommender

All Implemented Interfaces:

MyrrixRecommender, org.apache.mahout.cf.taste.common.Refreshable, org.apache.mahout.cf.taste.recommender.ItemBasedRecommender, org.apache.mahout.cf.taste.recommender.Recommender

public final class ClientRecommender
extends Object
implements MyrrixRecommender

An implementation of MyrrixRecommender which accesses a remote Serving Layer instance over HTTP or HTTPS. This is like a local "handle" on the remote recommender.

It is useful to note here, again, that the API methods setPreference(long, long) and removePreference(long, long), retained from Apache Mahout, have a somewhat different meaning than in Mahout. They add to an association strength, rather than replace it. See the javadoc.

There are a few advanced, system-wide parameters that can be set to affect how the client works. These should not normally be used:

• client.connection.close: Causes the client to request no HTTP keep-alive. This can avoid running out of local sockets on the client side during load testing, but should not otherwise be set.
• client.https.ignoreHost: When using HTTPS, ignore the host specified in the certificate. This can make development easier, but must not be used in production.

Since:

1.0

Author:

Sean Owen

Constructor Summary

Constructors

Constructor and Description
ClientRecommender(MyrrixClientConfiguration config) Instantiates a new recommender client with the given configuration

Method Summary

Methods

Modifier and Type	Method and Description
void	await()
boolean	await(long time, TimeUnit unit)
float	estimateForAnonymous(long toItemID, long[] itemIDs)
float	estimateForAnonymous(long toItemID, long[] itemIDs, float[] values)
float	estimateForAnonymous(long toItemID, long[] itemIDs, float[] values, Long contextUserID)
float	estimatePreference(long userID, long itemID)
float[]	estimatePreferences(long userID, long... itemIDs)
FastIDSet	getAllItemIDs()
FastIDSet	getAllUserIDs()
org.apache.mahout.cf.taste.model.DataModel	getDataModel() Deprecated. do not call
FastIDSet	getItemCluster(int n)
int	getNumItemClusters()
int	getNumUserClusters()
FastIDSet	getUserCluster(int n)
void	ingest(File file)
void	ingest(Reader reader)
boolean	isReady()
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	mostPopularItems(int howMany)
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	mostPopularItems(int howMany, org.apache.mahout.cf.taste.recommender.IDRescorer rescorer) Deprecated. use mostPopularItems(int) instead
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	mostSimilarItems(long[] itemIDs, int howMany) Computes items most similar to an item or items.
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	mostSimilarItems(long[] itemIDs, int howMany, boolean excludeItemIfNotSimilarToAll) Deprecated. use mostSimilarItems(long[], int) instead
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	mostSimilarItems(long[] itemIDs, int howMany, org.apache.mahout.cf.taste.recommender.Rescorer<org.apache.mahout.common.LongPair> rescorer) Deprecated. use mostSimilarItems(long[], int) instead
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	mostSimilarItems(long[] itemIDs, int howMany, org.apache.mahout.cf.taste.recommender.Rescorer<org.apache.mahout.common.LongPair> rescorer, boolean excludeItemIfNotSimilarToAll) Deprecated. use mostSimilarItems(long[], int) instead
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	mostSimilarItems(long[] itemIDs, int howMany, String[] rescorerParams, Long contextUserID) Like mostSimilarItems(long[], int), but allows caller to specify the user for which the request is being made.
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	mostSimilarItems(long itemID, int howMany) One-argument version of mostSimilarItems(long[], int).
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	mostSimilarItems(long itemID, int howMany, org.apache.mahout.cf.taste.recommender.Rescorer<org.apache.mahout.common.LongPair> rescorer) Deprecated. use mostSimilarItems(long, int) instead
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommend(long userID, int howMany) Like recommend(long, int, boolean, IDRescorer), and sets considerKnownItems to false and rescorer to null.
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommend(long userID, int howMany, boolean considerKnownItems, org.apache.mahout.cf.taste.recommender.IDRescorer rescorer) Deprecated. use recommend(long, int, boolean, String[]) instead
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommend(long userID, int howMany, boolean considerKnownItems, String[] rescorerParams)
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommend(long userID, int howMany, org.apache.mahout.cf.taste.recommender.IDRescorer rescorer) Deprecated. use recommend(long, int) instead
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommendedBecause(long userID, long itemID, int howMany) Lists the items that were most influential in recommending a given item to a given user.
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommendToAnonymous(long[] itemIDs, float[] values, int howMany)
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommendToAnonymous(long[] itemIDs, float[] values, int howMany, org.apache.mahout.cf.taste.recommender.IDRescorer rescorer) Deprecated. use recommendToAnonymous(long[], float[], int) instead
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommendToAnonymous(long[] itemIDs, float[] values, int howMany, String[] rescorerParams, Long contextUserID) Like recommendToAnonymous(long[], float[], int), but allows caller to specify the user for which the request is being made.
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommendToAnonymous(long[] itemIDs, int howMany)
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommendToAnonymous(long[] itemIDs, int howMany, org.apache.mahout.cf.taste.recommender.IDRescorer rescorer) Deprecated. use recommendToAnonymous(long[], int) instead
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommendToMany(long[] userIDs, int howMany, boolean considerKnownItems, org.apache.mahout.cf.taste.recommender.IDRescorer rescorer) Deprecated.
List<org.apache.mahout.cf.taste.recommender.RecommendedItem>	recommendToMany(long[] userIDs, int howMany, boolean considerKnownItems, String[] rescorerParams)
void	refresh() Requests that the Serving Layer recompute its models.
void	refresh(Collection<org.apache.mahout.cf.taste.common.Refreshable> alreadyRefreshed) Deprecated.
void	removePreference(long userID, long itemID)
void	setItemTag(String tag, long itemID)
void	setItemTag(String tag, long itemID, float value)
void	setItemTag(String tag, long itemID, float value, Long contextUserID) Like setItemTag(String, long, float), but allows caller to specify the user for which the request is being made.
void	setPreference(long userID, long itemID) Calls setPreference(long, long, float) with value 1.0.
void	setPreference(long userID, long itemID, float value)
void	setUserTag(long userID, String tag)
void	setUserTag(long userID, String tag, float value)
float[]	similarityToItem(long toItemID, long... itemIDs)
float[]	similarityToItem(long toItemID, long[] itemIDs, Long contextUserID) Like similarityToItem(long, long[]), but allows caller to specify the user for which the request is being made.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientRecommender

public ClientRecommender(MyrrixClientConfiguration config)
                  throws IOException

Instantiates a new recommender client with the given configuration

Parameters:

config - configuration to use with this client

Throws:

IOException - if the HTTP client encounters an error during configuration

Method Detail

setPreference

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

Calls setPreference(long, long, float) with value 1.0.

Specified by:

setPreference in interface MyrrixRecommender

Throws:

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

setPreference

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

Specified by:

setPreference in interface MyrrixRecommender

Specified by:

setPreference in interface org.apache.mahout.cf.taste.recommender.Recommender

Throws:

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

removePreference

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

Specified by:

removePreference in interface MyrrixRecommender

Specified by:

removePreference in interface org.apache.mahout.cf.taste.recommender.Recommender

Throws:

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

setUserTag

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

Specified by:

setUserTag in interface MyrrixRecommender

Throws:

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

setUserTag

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

Specified by:

setUserTag in interface MyrrixRecommender

Throws:

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

setItemTag

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

Specified by:

setItemTag in interface MyrrixRecommender

Throws:

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

setItemTag

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

Specified by:

setItemTag in interface MyrrixRecommender

Throws:

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

setItemTag

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

Like setItemTag(String, long, float), but allows caller to specify the user for which the request is being made. This information does not directly affect the computation, but affects routing of the request in a distributed context. This is always recommended when there is a user in whose context the request is being made, as it will ensure that the request can take into account all the latest information from the user, including a very new item like itemID.

Throws:

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

estimatePreference

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

Specified by:

estimatePreference in interface MyrrixRecommender

Specified by:

estimatePreference in interface org.apache.mahout.cf.taste.recommender.Recommender

Parameters:

userID - user ID whose preference is to be estimated

itemID - item ID to estimate preference for

Returns:

an estimate of the strength of the association between the user and item. These values are the same as will be returned from recommend(long, int). They are opaque values and have no interpretation other than that larger means stronger. The values are typically in the range [0,1] but are not guaranteed to be so. Note that 0 will be returned if the user or item is not known in the data.

Throws:

NotReadyException - if the recommender has no model available yet

org.apache.mahout.cf.taste.common.TasteException - if another error occurs

estimatePreferences

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

Specified by:

estimatePreferences in interface MyrrixRecommender

Throws:

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

estimateForAnonymous

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

Specified by:

estimateForAnonymous in interface MyrrixRecommender

Throws:

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

estimateForAnonymous

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

Specified by:

estimateForAnonymous in interface MyrrixRecommender

Throws:

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

estimateForAnonymous

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

Throws:

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

recommend

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

Like recommend(long, int, boolean, IDRescorer), and sets considerKnownItems to false and rescorer to null.

Specified by:

recommend in interface MyrrixRecommender

Specified by:

recommend in interface org.apache.mahout.cf.taste.recommender.Recommender

Throws:

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

recommend

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

Parameters:

userID - user for which recommendations are to be computed

howMany - desired number of recommendations

considerKnownItems - if true, items that the user is already associated to are candidates for recommendation. Normally this is false.

rescorerParams - optional parameters to send to the server's RescorerProvider

Returns:

List of recommended RecommendedItems, ordered from most strongly recommend to least

Throws:

org.apache.mahout.cf.taste.common.NoSuchUserException - if the user is not known in the model

NotReadyException - if the recommender has no model available yet

org.apache.mahout.cf.taste.common.TasteException - if another error occurs

UnsupportedOperationException - if rescorer is not null

recommendToMany

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

Parameters:

userIDs - users for which recommendations are to be computed

howMany - desired number of recommendations

considerKnownItems - if true, items that the user is already associated to are candidates for recommendation. Normally this is false.

rescorerParams - optional parameters to send to the server's RescorerProvider

Returns:

List of recommended RecommendedItems, ordered from most strongly recommend to least

Throws:

org.apache.mahout.cf.taste.common.NoSuchUserException - if none of userIDs are known in the model. Otherwise unknown user IDs are ignored.

NotReadyException - if the recommender has no model available yet

org.apache.mahout.cf.taste.common.TasteException - if another error occurs

UnsupportedOperationException - if rescorer is not null

recommendToAnonymous

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

Specified by:

recommendToAnonymous in interface MyrrixRecommender

Throws:

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

recommendToAnonymous

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

Specified by:

recommendToAnonymous in interface MyrrixRecommender

Throws:

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

recommendToAnonymous

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

Like recommendToAnonymous(long[], float[], int), but allows caller to specify the user for which the request is being made. This information does not directly affect the computation, but affects routing of the request in a distributed context. This is always recommended when there is a user in whose context the request is being made, as it will ensure that the request can take into account all the latest information from the user, including very new items that may be in itemIDs.

Throws:

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

mostPopularItems

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

Specified by:

mostPopularItems in interface MyrrixRecommender

Throws:

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

mostSimilarItems

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

Computes items most similar to an item or items. The returned items have the highest average similarity to the given items.

Specified by:

mostSimilarItems in interface MyrrixRecommender

Specified by:

mostSimilarItems in interface org.apache.mahout.cf.taste.recommender.ItemBasedRecommender

Parameters:

itemIDs - items for which most similar items are required

howMany - maximum number of similar items to return; fewer may be returned

Returns:

RecommendedItems representing the top recommendations for the user, ordered by quality, descending. The score associated to it is an opaque value. Larger means more similar, but no further interpretation may necessarily be applied.

Throws:

org.apache.mahout.cf.taste.common.NoSuchItemException - if none of itemIDs exist in the model. Otherwise, unknown items are ignored.

NotReadyException - if the recommender has no model available yet

org.apache.mahout.cf.taste.common.TasteException - if another error occurs

mostSimilarItems

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

Like mostSimilarItems(long[], int), but allows caller to specify the user for which the request is being made. This information does not directly affect the computation, but affects routing of the request in a distributed context. This is always recommended when there is a user in whose context the request is being made, as it will ensure that the request can take into account all the latest information from the user, including very new items that may be in itemIDs.

Throws:

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

mostSimilarItems

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

One-argument version of mostSimilarItems(long[], int).

Specified by:

mostSimilarItems in interface MyrrixRecommender

Specified by:

mostSimilarItems in interface org.apache.mahout.cf.taste.recommender.ItemBasedRecommender

Throws:

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

similarityToItem

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

Specified by:

similarityToItem in interface MyrrixRecommender

Throws:

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

similarityToItem

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

Like similarityToItem(long, long[]), but allows caller to specify the user for which the request is being made. This information does not directly affect the computation, but affects routing of the request in a distributed context. This is always recommended when there is a user in whose context the request is being made, as it will ensure that the request can take into account all the latest information from the user, including very new items that may be in itemIDs.

Throws:

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

recommendedBecause

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

Lists the items that were most influential in recommending a given item to a given user. Exactly how this is determined is left to the implementation, but, generally this will return items that the user prefers and that are similar to the given item.

These values by which the results are ordered are opaque values and have no interpretation other than that larger means stronger.

Specified by:

recommendedBecause in interface MyrrixRecommender

Specified by:

recommendedBecause in interface org.apache.mahout.cf.taste.recommender.ItemBasedRecommender

Parameters:

userID - ID of user who was recommended the item

itemID - ID of item that was recommended

howMany - maximum number of items to return

Returns:

List of RecommendedItem, ordered from most influential in recommended the given item to least

Throws:

org.apache.mahout.cf.taste.common.NoSuchUserException - if the user is not known in the model

org.apache.mahout.cf.taste.common.NoSuchItemException - if the item is not known in the model

NotReadyException - if the recommender has no model available yet

org.apache.mahout.cf.taste.common.TasteException - if another error occurs

ingest

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

Specified by:

ingest in interface MyrrixRecommender

Throws:

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

ingest

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

Specified by:

ingest in interface MyrrixRecommender

Throws:

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

refresh

@Deprecated
public void refresh(Collection<org.apache.mahout.cf.taste.common.Refreshable> alreadyRefreshed)

Deprecated.

Specified by:

refresh in interface MyrrixRecommender

Specified by:

refresh in interface org.apache.mahout.cf.taste.common.Refreshable

refresh

public void refresh()

Requests that the Serving Layer recompute its models. This is a request, and may or may not result in an update.

Specified by:

refresh in interface MyrrixRecommender

getDataModel

@Deprecated
public org.apache.mahout.cf.taste.model.DataModel getDataModel()

Deprecated. do not call

Not available. The client does not directly use any DataModel.

Specified by:

getDataModel in interface MyrrixRecommender

Specified by:

getDataModel in interface org.apache.mahout.cf.taste.recommender.Recommender

Throws:

UnsupportedOperationException

recommend

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> recommend(long userID,
                                                                                int howMany,
                                                                                org.apache.mahout.cf.taste.recommender.IDRescorer rescorer)
                                                                       throws org.apache.mahout.cf.taste.common.TasteException

Deprecated. use recommend(long, int) instead

Rescorers are not available at this time in the model.

Specified by:

recommend in interface MyrrixRecommender

Specified by:

recommend in interface org.apache.mahout.cf.taste.recommender.Recommender

Returns:

recommend(long, int) if rescorer is null

Throws:

UnsupportedOperationException - otherwise

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

recommend

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> recommend(long userID,
                                                                                int howMany,
                                                                                boolean considerKnownItems,
                                                                                org.apache.mahout.cf.taste.recommender.IDRescorer rescorer)
                                                                       throws org.apache.mahout.cf.taste.common.TasteException

Deprecated. use recommend(long, int, boolean, String[]) instead

Rescorers are not available at this time in the model.

Specified by:

recommend in interface MyrrixRecommender

Returns:

recommend(long, int, boolean, String[]) if rescorer is null

Throws:

UnsupportedOperationException - otherwise

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

recommendToMany

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> recommendToMany(long[] userIDs,
                                                                                      int howMany,
                                                                                      boolean considerKnownItems,
                                                                                      org.apache.mahout.cf.taste.recommender.IDRescorer rescorer)
                                                                             throws org.apache.mahout.cf.taste.common.TasteException

Deprecated.

Specified by:

recommendToMany in interface MyrrixRecommender

Throws:

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

recommendToAnonymous

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> recommendToAnonymous(long[] itemIDs,
                                                                                           int howMany,
                                                                                           org.apache.mahout.cf.taste.recommender.IDRescorer rescorer)
                                                                                  throws org.apache.mahout.cf.taste.common.TasteException

Deprecated. use recommendToAnonymous(long[], int) instead

Note that IDRescorer is not supported in the client now and must be null.

Specified by:

recommendToAnonymous in interface MyrrixRecommender

Returns:

recommendToAnonymous(long[], int) if rescorer is null

Throws:

UnsupportedOperationException - otherwise

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

recommendToAnonymous

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> recommendToAnonymous(long[] itemIDs,
                                                                                           float[] values,
                                                                                           int howMany,
                                                                                           org.apache.mahout.cf.taste.recommender.IDRescorer rescorer)
                                                                                  throws org.apache.mahout.cf.taste.common.TasteException

Deprecated. use recommendToAnonymous(long[], float[], int) instead

Note that IDRescorer is not supported in the client now and must be null.

Specified by:

recommendToAnonymous in interface MyrrixRecommender

Returns:

recommendToAnonymous(long[], float[], int) if rescorer is null

Throws:

UnsupportedOperationException - otherwise

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

mostPopularItems

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> mostPopularItems(int howMany,
                                                                                       org.apache.mahout.cf.taste.recommender.IDRescorer rescorer)
                                                                              throws org.apache.mahout.cf.taste.common.TasteException

Deprecated. use mostPopularItems(int) instead

Note that IDRescorer is not supported in the client now and must be null.

Specified by:

mostPopularItems in interface MyrrixRecommender

Returns:

mostPopularItems(int) if rescorer is null

Throws:

UnsupportedOperationException - otherwise

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

mostSimilarItems

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> mostSimilarItems(long itemID,
                                                                                       int howMany,
                                                                                       org.apache.mahout.cf.taste.recommender.Rescorer<org.apache.mahout.common.LongPair> rescorer)
                                                                              throws org.apache.mahout.cf.taste.common.TasteException

Deprecated. use mostSimilarItems(long, int) instead

Rescorers are not available at this time in the model.

Specified by:

mostSimilarItems in interface MyrrixRecommender

Specified by:

mostSimilarItems in interface org.apache.mahout.cf.taste.recommender.ItemBasedRecommender

Returns:

mostSimilarItems(long, int) if rescorer is null

Throws:

UnsupportedOperationException - otherwise

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

mostSimilarItems

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> mostSimilarItems(long[] itemIDs,
                                                                                       int howMany,
                                                                                       org.apache.mahout.cf.taste.recommender.Rescorer<org.apache.mahout.common.LongPair> rescorer)
                                                                              throws org.apache.mahout.cf.taste.common.TasteException

Deprecated. use mostSimilarItems(long[], int) instead

Rescorers are not available at this time in the model.

Specified by:

mostSimilarItems in interface MyrrixRecommender

Specified by:

mostSimilarItems in interface org.apache.mahout.cf.taste.recommender.ItemBasedRecommender

Returns:

mostSimilarItems(long[], int) if rescorer is null

Throws:

UnsupportedOperationException - otherwise

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

mostSimilarItems

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> mostSimilarItems(long[] itemIDs,
                                                                                       int howMany,
                                                                                       boolean excludeItemIfNotSimilarToAll)
                                                                              throws org.apache.mahout.cf.taste.common.TasteException

Deprecated. use mostSimilarItems(long[], int) instead

excludeItemIfNotSimilarToAll is not applicable in this implementation.

Specified by:

mostSimilarItems in interface MyrrixRecommender

Specified by:

mostSimilarItems in interface org.apache.mahout.cf.taste.recommender.ItemBasedRecommender

Returns:

mostSimilarItems(long[], int) if excludeItemIfNotSimilarToAll is false

Throws:

UnsupportedOperationException - otherwise

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

mostSimilarItems

@Deprecated
public List<org.apache.mahout.cf.taste.recommender.RecommendedItem> mostSimilarItems(long[] itemIDs,
                                                                                       int howMany,
                                                                                       org.apache.mahout.cf.taste.recommender.Rescorer<org.apache.mahout.common.LongPair> rescorer,
                                                                                       boolean excludeItemIfNotSimilarToAll)
                                                                              throws org.apache.mahout.cf.taste.common.TasteException

Deprecated. use mostSimilarItems(long[], int) instead

Rescorers are not available at this time in the model. excludeItemIfNotSimilarToAll is not applicable in this implementation.

Specified by:

mostSimilarItems in interface MyrrixRecommender

Specified by:

mostSimilarItems in interface org.apache.mahout.cf.taste.recommender.ItemBasedRecommender

Returns:

mostSimilarItems(long[], int) if excludeItemIfNotSimilarToAll is false and rescorer is null

Throws:

UnsupportedOperationException - otherwise

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

isReady

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

Specified by:

isReady in interface MyrrixRecommender

Throws:

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

await

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

Specified by:

await in interface MyrrixRecommender

Throws:

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

InterruptedException

await

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

Specified by:

await in interface MyrrixRecommender

Throws:

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

InterruptedException

getAllUserIDs

public FastIDSet getAllUserIDs()
                        throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

getAllUserIDs in interface MyrrixRecommender

Throws:

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

getAllItemIDs

public FastIDSet getAllItemIDs()
                        throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

getAllItemIDs in interface MyrrixRecommender

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 MyrrixRecommender

Throws:

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

getNumItemClusters

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

Specified by:

getNumItemClusters in interface MyrrixRecommender

Throws:

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

getUserCluster

public FastIDSet getUserCluster(int n)
                         throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

getUserCluster in interface MyrrixRecommender

Throws:

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

getItemCluster

public FastIDSet getItemCluster(int n)
                         throws org.apache.mahout.cf.taste.common.TasteException

Specified by:

getItemCluster in interface MyrrixRecommender

Throws:

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