API Reference#

These pages contain the reference documentation for the LensKit modules, classes, etc.

Core Abstractions#

`lenskit.data`
`lenskit.pipeline`	LensKit pipeline abstraction.
`lenskit.diagnostics`	Warning and error classes and general LensKit diagnostic code.
`lenskit.types`

Components and Models#

These packages provide various recommendation components and models. Many of them need to be installed separately.

`lenskit.algorithms`	LensKit algorithms.
`lenskit.funksvd`	FunkSVD (biased MF).
`lenskit.implicit`
`lenskit.hpf`

Batch Inference and Evaluation#

These package provide evaluation metrics and analysis and batch-inference support. The evaluation code is not directly linked to the rest of LensKit and can be used to evaluate the output of any recommender system implementation.

`lenskit.batch`	Batch-run predictors and recommenders for evaluation.
`lenskit.metrics`	Metrics for evaluating recommendations.
`lenskit.topn`
`lenskit.splitting`	Splitting data for train-test evaluation.

Implementation Helpers#

These modules provide various utilities and helpers used to implement LensKit, and may be useful in building new models and components for LensKit.

`lenskit.math`	Mathematical helper routines.
`lenskit.parallel`	LensKit parallel computation support.
`lenskit.util`	Miscellaneous utility functions.