Home - shark8me/lenskit GitHub Wiki
LensKit Recommender Toolkit
LensKit is an open-source toolkit for building, researching, and studying recommedner systems. This is the entry point for LensKit's general documentation, both for using it and developing it.
You likely also want to look at the home page, which houses release information and news.
I want to use LensKit
Great! The easiest way to start using LensKit is with Maven, either adding it as a dependency to your project or creating a new recommender evaluation project. Our Getting Started guide has more information on getting your first LensKit project up and running.
If you use LensKit in published research, please cite our paper “Rethinking the Recommender Research Ecosystem: Reproducibility, Openness, and LensKit”.
I want to contribute to LensKit
We love to receive contributions to LensKit. There are many ways you can help:
- Write documentation in the wiki (here)
- Fix bugs
- Write and clean up API documentation
- Implement new algorithms, either in the LensKit source tree or as external add-ons (which we highly encourage)
If you've got an itch to scratch with LensKit, scratch it and send a pull request. We also encourage you to discuss your ideas on the mailing list.
We also have a variety of documents that are useful for contributors:
- The README describes how to get the LensKit source code what is needed to start working with it.
- The LensKit branching model (based on git-flow).
- Code guidelines, describing the coding style we use.
- Key Patterns we use in the LensKit code base (includes some naming convention notes).
- Development tips collects various tips, tricks, and bug workarounds we have found.
If you want to make a code contribution, fork the main LensKit repository and submit a pull request. When submitting a pull request via GitHub, you warrant that you either own the code or have appropriate authority to submit it, and license your changes under LensKit's copyright license (LGPLv2.1+).