Source

lenskit / README

Full commit
.. -*- restructuredtext -*-

LensKit
=======

LensKit is an implementation of collaborative filtering algorithms and
a set of tools for benchmarking them.  For more information about
LensKit and the documentation, visit the `web site`_.

.. _web site: http://lenskit.grouplens.org

Installation and Dependency Management
--------------------------------------

LensKit is managed and deployed via Maven_.  To install it, check out
this repository and run ``mvn install``.  It can also be checked out
in Eclipse with M2Eclipse_ by cloning the repository with
MercurialEclipse_, then importing the submodules as Existing Maven
projects.

.. _Maven: http://maven.apache.org
.. _M2Eclipse: http://m2eclipse.sonatype.org/installing-m2eclipse.html

Modules
-------

LensKit is comprised of several modules.  The top-level ``lenskit``
module serves as a container to build them and provide common settings
and dependencies.  The other modules are as follows:

``lenskit-core``
    The core APIs, data structures, and configuration facilities for
    the rest of LensKit.
``lenskit-knn``
    k-NN recommenders (user-user and item-item collaborative
    filtering).
``lenskit-svd``
    The FunkSVD recommender (and eventually real SVD recommenders).
``lenskit-slopeone``
    Slope-One recommenders.
``lenskit-eval``
    The evaluation framework and APIs.
``lenskit-eval-ant-plugin``
    Ant_ plugin for running evaluations of LensKit recommenders.

.. _Ant: http://ant.apache.org