Skip to content

A Python scikit for building and analyzing recommender systems

License

Notifications You must be signed in to change notification settings

nathania/Surprise

Repository files navigation

GitHub version Doc Build Status [python_versions] (https://pypi.python.org/pypi/recsys/) license

RecSys

author: Nicolas Hug

Overview

RecSys is an open source Python package that provides with tools to build and evaluate the performance of many recommender system prediction algorithms. Its goal is to make life easy(-ier) for reseachers and students who want to play around with new recommender algorithm ideas.

A strong emphasis is laid on documentation, which we have tried to make as clear and precise as possible by pointing out every detail of the algorithms, in order for the practitioner to have perfect control over his experiments.

Features

  • A great doc! (we hope)
  • Dataset handling is made easy.
  • Various ready-to-use prediction algorithms.
  • Easy to implement new algorithm ideas.
  • Evaluate, analyse and compare the algorithms performance.

Installation / Usage

Please, use a virtual env

To install from PyPI, use pip:

$ pip install recsys

Or clone the repo:

$ git clone https://github.com/Niourf/recsys.git
$ cd recsys
$ pip install -r requirements.txt
$ pip install -r requirements_dev.txt
$ # then either
$ pip install .  # or below
$ python setup.py install

Documentation, Getting Started

The documentation with many usage examples is available online on ReadTheDocs.

License

This project is licensed under the GPLv3 license - see the LICENSE.md file for details.

Acknowledgements:

About

A Python scikit for building and analyzing recommender systems

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%