org.grouplens.lenskit.eval.traintest

Interface TestUser

All Known Implementing Classes:

AbstractTestUser, LenskitTestUser, MockTestUser

public interface TestUser

Expose recommender data to evaluate recommendations and predictions for a single user.

Method Summary

Modifier and Type	Method and Description
SparseVector	getPredictions() Get the user's predictions.
List<ScoredId>	getRecommendations(int n, ItemSelector candSel, ItemSelector exclSel) Get the user's recommendations.
Recommender	getRecommender() Get the recommender
UserHistory<Event>	getTestHistory() Return this user's test history.
SparseVector	getTestRatings() Get the user's test ratings.
UserHistory<Event>	getTrainHistory() Return this user's training history.
long	getUserId() Get the ID of this user.

Method Detail

getUserId

long getUserId()

Get the ID of this user.

Returns:

The user's ID.

getTrainHistory

UserHistory<Event> getTrainHistory()

Return this user's training history.

Returns:

The history of the user from the training/query set.

getTestHistory

UserHistory<Event> getTestHistory()

Return this user's test history.

Returns:

The history of the user from the test set.

getTestRatings

SparseVector getTestRatings()

Get the user's test ratings. Summarizes the user's ratings from the history.

Returns:

The user's ratings for the test items.

getPredictions

@Nullable
SparseVector getPredictions()

Get the user's predictions.

Returns:

The predictions of the user's preference for items, or null if the algorithmInfo does not support rating prediction.

getRecommendations

@Nullable
List<ScoredId> getRecommendations(int n,
                                            ItemSelector candSel,
                                            ItemSelector exclSel)

Get the user's recommendations.

Parameters:

n - The number of recommendations to generate.

candSel - The candidate selector.

exclSel - The exclude selector.

Returns:

Some recommendations for the user, or null if the recommender does not support recommendation.

See Also:

ItemRecommender.recommend(long, int, java.util.Set, java.util.Set)

getRecommender

@Nullable
Recommender getRecommender()

Get the recommender

Returns:

The recommender.