com.planetj.taste.recommender
Interface ItemBasedRecommender

All Superinterfaces:

Recommender, Refreshable

All Known Implementing Classes:

GenericItemBasedRecommender

public interface ItemBasedRecommender
extends Recommender

Interface implemented by "item-based" recommenders.

Since:

1.1

Author:

Sean Owen

Method Summary

java.util.List<RecommendedItem>	mostSimilarItems(java.util.List<java.lang.Object> itemIDs, int howMany)
java.util.List<RecommendedItem>	mostSimilarItems(java.util.List<java.lang.Object> itemIDs, int howMany, Rescorer<Pair<Item,Item>> rescorer)
java.util.List<RecommendedItem>	mostSimilarItems(java.lang.Object itemID, int howMany)
java.util.List<RecommendedItem>	mostSimilarItems(java.lang.Object itemID, int howMany, Rescorer<Pair<Item,Item>> rescorer)
java.util.List<RecommendedItem>	recommendedBecause(java.lang.Object userID, java.lang.Object itemID, int howMany) Lists the Items that were most influential in recommending a given item to a given user.

Methods inherited from interface com.planetj.taste.recommender.Recommender

estimatePreference, getDataModel, recommend, recommend, removePreference, setPreference

Methods inherited from interface com.planetj.taste.common.Refreshable

refresh

Method Detail

mostSimilarItems

@NotNull
java.util.List<RecommendedItem> mostSimilarItems(java.lang.Object itemID,
                                                         int howMany)
                                                 throws TasteException

Parameters:

itemID - ID of Item for which to find most similar other Items

howMany - desired number of most similar Items to find

Returns:

Items most similar to the given item, ordered from most similar to least

Throws:

TasteException - if an error occurs while accessing the DataModel

mostSimilarItems

@NotNull
java.util.List<RecommendedItem> mostSimilarItems(java.lang.Object itemID,
                                                         int howMany,
                                                         Rescorer<Pair<Item,Item>> rescorer)
                                                 throws TasteException

Parameters:

itemID - ID of Item for which to find most similar other Items

howMany - desired number of most similar Items to find

rescorer - Rescorer which can adjust item-item correlation estimates used to determine most similar items

Returns:

Items most similar to the given item, ordered from most similar to least

Throws:

TasteException - if an error occurs while accessing the DataModel

Since:

1.5.1

mostSimilarItems

@NotNull
java.util.List<RecommendedItem> mostSimilarItems(java.util.List<java.lang.Object> itemIDs,
                                                         int howMany)
                                                 throws TasteException

Parameters:

itemIDs - IDs of Item for which to find most similar other Items

howMany - desired number of most similar Items to find estimates used to determine most similar items

Returns:

Items most similar to the given items, ordered from most similar to least

Throws:

TasteException - if an error occurs while accessing the DataModel

Since:

1.5.4

mostSimilarItems

@NotNull
java.util.List<RecommendedItem> mostSimilarItems(java.util.List<java.lang.Object> itemIDs,
                                                         int howMany,
                                                         Rescorer<Pair<Item,Item>> rescorer)
                                                 throws TasteException

Parameters:

itemIDs - IDs of Item for which to find most similar other Items

howMany - desired number of most similar Items to find

rescorer - Rescorer which can adjust item-item correlation estimates used to determine most similar items

Returns:

Items most similar to the given items, ordered from most similar to least

Throws:

TasteException - if an error occurs while accessing the DataModel

Since:

1.5.4

recommendedBecause

@NotNull
java.util.List<RecommendedItem> recommendedBecause(java.lang.Object userID,
                                                           java.lang.Object itemID,
                                                           int howMany)
                                                   throws 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.

This returns a List of RecommendedItem which is a little misleading since it's returning recommending items, but, I thought it more natural to just reuse this class since it encapsulates an Item and value. The value here does not necessarily have a consistent interpretation or expected range; it will be higher the more influential the Item was in the recommendation.

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:

TasteException - if an error occurs while accessing the DataModel

Since:

1.5.5