org.grouplens.lenskit

Interface Recommender

All Known Implementing Classes:

LenskitRecommender

public interface Recommender

Main entry point for accessing recommender components. A recommender object is effectively a recommender session: it is a per-thread or per-request object, likely connected to a database connection or persistence session, that needs to be closed when the client code is finished with it.

The various methods in this class return null if the corresponding operation is not supported by the underlying recommender configuration. This ensures that, if you can actually get an object implementing a particular interface, you are guaranteed to be able to use it.

See Also:

RecommenderEngine

Compatibility

Public

Method Summary

Modifier and Type	Method and Description
GlobalItemRecommender	getGlobalItemRecommender() Get the recommender's global item recommender.
GlobalItemScorer	getGlobalItemScorer() Get the recommender's global item scorer.
ItemRecommender	getItemRecommender() Get the recommender's item recommender.
ItemScorer	getItemScorer() Get the recommender's item scorer.
RatingPredictor	getRatingPredictor() Get the recommender's rating scorer.

Method Detail

getItemScorer

@Nullable
ItemScorer getItemScorer()

Get the recommender's item scorer.

Returns:

The item scorer for this recommender configuration, or null if item scoring is not supported.

getGlobalItemScorer

@Nullable
GlobalItemScorer getGlobalItemScorer()

Get the recommender's global item scorer.

Returns:

The global item scorer for this recommender configuration, or null if item scoring is not supported.

getRatingPredictor

@Nullable
RatingPredictor getRatingPredictor()

Get the recommender's rating scorer.

Returns:

The rating predictor for this recommender configuration, or null if rating prediction is not supported.

getItemRecommender

@Nullable
ItemRecommender getItemRecommender()

Get the recommender's item recommender.

Returns:

The item recommender for this recommender configuration, or null if item recommendation is not supported.

getGlobalItemRecommender

@Nullable
GlobalItemRecommender getGlobalItemRecommender()

Get the recommender's global item recommender.

Returns:

The item recommender for this recommender configuration, or null if item recommendation is not supported.