org.lenskit.api

Interface ItemBasedItemScorer

All Known Implementing Classes:

AbstractItemBasedItemScorer, ItemItemItemBasedItemScorer

public interface ItemBasedItemScorer

Score items with reference to specified item(s). These scores can be predicted relevance scores, purchase probabilities, or any other real-valued score which can be assigned to an item relative to a given item. This interface is distinguished from ItemScorer in that it uses a set of reference items instead of a user as the basis for computing scores.

Compatibility

Public

Method Summary

Modifier and Type	Method and Description
Result	scoreRelatedItem(java.util.Collection<java.lang.Long> basket, long item) Score a single item based on a collection of items (e.g.
java.util.Map<java.lang.Long,java.lang.Double>	scoreRelatedItems(java.util.Collection<java.lang.Long> basket, java.util.Collection<java.lang.Long> items) Score a collection of items based on a collection of items (e.g.
ResultMap	scoreRelatedItemsWithDetails(java.util.Collection<java.lang.Long> basket, java.util.Collection<java.lang.Long> items) Score a collection of items based on a collection of items (e.g.

Method Detail

scoreRelatedItem

Result scoreRelatedItem(@Nonnull
                        java.util.Collection<java.lang.Long> basket,
                        long item)

Score a single item based on a collection of items (e.g. a shopping basket).

Parameters:

basket - The objective items ID used as the query

item - The item ID to score.

Returns:

The relevance score, or null if no score can be predicted.

scoreRelatedItems

@Nonnull
java.util.Map<java.lang.Long,java.lang.Double> scoreRelatedItems(@Nonnull
                                                                          java.util.Collection<java.lang.Long> basket,
                                                                          @Nonnull
                                                                          java.util.Collection<java.lang.Long> items)

Score a collection of items based on a collection of items (e.g. a shopping basket).

Parameters:

basket - The objective items ID used as the query

items - The list of items to score.

Returns:

A mapping from item IDs to relevance scores. This mapping may not contain all requested items.

scoreRelatedItemsWithDetails

ResultMap scoreRelatedItemsWithDetails(@Nonnull
                                       java.util.Collection<java.lang.Long> basket,
                                       java.util.Collection<java.lang.Long> items)

Score a collection of items based on a collection of items (e.g. a shopping basket), with details.

Parameters:

basket - The items to use as the query.

items - The items to score.

Returns:

The scores for the items, possibly with additional details (will be represented as a subclass of Result.