Metadata-Version: 2.1
Name: lenskit
Version: 0.13.1
Summary: The LensKit package.
Home-page: https://lenskit.lenskit.org
Author: Michael Ekstrand
Author-email: michaelekstrand@boisestate.edu
Requires-Python: >= 3.7
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Requires-Dist: pandas >= 0.24
Requires-Dist: numpy >= 1.17
Requires-Dist: scipy >= 1.2
Requires-Dist: numba >= 0.51, < 0.54
Requires-Dist: pyarrow >= 0.15
Requires-Dist: cffi >= 1.12.2
Requires-Dist: psutil >= 5
Requires-Dist: binpickle >= 0.3.2
Requires-Dist: seedbank >= 0.1.0
Requires-Dist: csr >= 0.3.1
Requires-Dist: notebook >= 6 ; extra == "demo"
Requires-Dist: nbval >= 0.9 ; extra == "demo"
Requires-Dist: matplotlib ~= 3.4 ; extra == "demo"
Requires-Dist: flit >= 3 ; extra == "dev"
Requires-Dist: packaging >= 20 ; extra == "dev"
Requires-Dist: flake8 >= 3 ; extra == "dev"
Requires-Dist: coverage >= 5 ; extra == "dev"
Requires-Dist: pytest-cov >= 2.12 ; extra == "dev"
Requires-Dist: ipython >= 7 ; extra == "dev"
Requires-Dist: docopt >= 0.6 ; extra == "dev"
Requires-Dist: tqdm >= 4 ; extra == "dev"
Requires-Dist: sphinx-autobuild >= 2021 ; extra == "dev"
Requires-Dist: sphinx >= 3 ; extra == "doc"
Requires-Dist: sphinx_rtd_theme >= 0.5 ; extra == "doc"
Requires-Dist: nbsphinx >= 0.8 ; extra == "doc"
Requires-Dist: hpfrec ; extra == "hpf"
Requires-Dist: implicit ; extra == "implicit"
Requires-Dist: scikit-learn >= 0.22 ; extra == "sklearn"
Requires-Dist: pytest >= 6 ; extra == "test"
Requires-Dist: pytest-doctestplus >= 0.9 ; extra == "test"
Requires-Dist: hypothesis >= 6 ; extra == "test"
Requires-Dist: tensorflow >= 2.1 ; extra == "tf"
Provides-Extra: demo
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: hpf
Provides-Extra: implicit
Provides-Extra: sklearn
Provides-Extra: test
Provides-Extra: tf

# Python recommendation tools

![Test Suite](https://github.com/lenskit/lkpy/workflows/Test%20Suite/badge.svg)
[![codecov](https://codecov.io/gh/lenskit/lkpy/branch/master/graph/badge.svg)](https://codecov.io/gh/lenskit/lkpy)
[![Maintainability](https://api.codeclimate.com/v1/badges/c02098c161112e19c148/maintainability)](https://codeclimate.com/github/lenskit/lkpy/maintainability)

LensKit is a set of Python tools for experimenting with and studying recommender
systems.  It provides support for training, running, and evaluating recommender
algorithms in a flexible fashion suitable for research and education.

LensKit for Python (LKPY) is the successor to the Java-based LensKit project.

If you use LensKit for Python in published research, please cite:

> Michael D. Ekstrand. 2020.
> LensKit for Python: Next-Generation Software for Recommender Systems Experiments.
> In <cite>Proceedings of the 29th ACM International Conference on Information and Knowledge Management</cite> (CIKM '20).
> DOI:[10.1145/3340531.3412778](https://dx.doi.org/10.1145/3340531.3412778).
> arXiv:[1809.03125](https://arxiv.org/abs/1809.03125) [cs.IR].

## Installing

To install the current release with Anaconda (recommended):

    conda install -c conda-forge lenskit

Or you can use `pip`:

    pip install lenskit

To use the latest development version, install directly from GitHub:

    pip install -U git+https://github.com/lenskit/lkpy

Then see [Getting Started](https://lkpy.lenskit.org/en/latest/GettingStarted.html)

## Developing

[issues]: https://github.com/lenskit/lkpy/issues
[workflow]: https://github.com/lenskit/lkpy/wiki/DevWorkflow

To contribute to LensKit, clone or fork the repository, get to work, and submit
a pull request.  We welcome contributions from anyone; if you are looking for a
place to get started, see the [issue tracker][].

Our development workflow is documented in [the wiki][workflow]; the wiki also
contains other information on *developing* LensKit. User-facing documentation is
at <https://lkpy.lenskit.org>.


We recommend using an Anaconda environment for developing LensKit.  To set this
up, run:

    pip install flit_core packaging
    python build-tools/flit-conda.py --create-env --python-version 3.8

This will create a Conda environment called `lkpy` with the packages required to develop and test
LensKit.

We don't maintain the Conda environment specification directly - instead, we
maintain information in `setup.toml` to be able to generate it, so that we define
dependencies and versions in one place.  The `flit-conda` package uses Flit's
configuration parser to load this data and generate Conda environment files.

## Resources

- [Documentation](https://lkpy.lenskit.org)
- [Mailing list, etc.](https://lenskit.org/connect)

## Acknowledgements

This material is based upon work supported by the National Science Foundation
under Grant No. IIS 17-51278. Any opinions, findings, and conclusions or
recommendations expressed in this material are those of the author(s) and do not
necessarily reflect the views of the National Science Foundation.

