Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Fast KNN Similarity Algorithms for Collaborative Filtering Models using sparse matrices

Project description

similaripy

SimilariPy

PY_PIC PYPI_PIC BUILD_STATUS_PIC LICENSE_PIC DOI_PIC

This project provides fast Python implementation of several KNN (K-Nearest Neighbors) similarity algorithms using sparse matrices, useful in Collaborative Filtering Recommender Systems and others.

The package also include some normalization functions that could be useful in the pre-processing phase before the similarity computation.

Similarities

Base similarity models:

  • Dot Product
  • Cosine
  • Asymmetric Cosine
  • Jaccard
  • Dice
  • Tversky

Graph-based similarity models:

  • P3α
  • RP3β

Advanced similarity model:

  • S-Plus

Similarities Documentation

All models have multi-threaded routines, using Cython and OpenMP to fit the models in parallel among all available CPU cores.

Normalizations

The package contains normalization functions like: l1, l2, max, tf-idf, bm25, bm25+.

All the functions are compiled at low-level and could operate in-place, on csr-matrixes, if you need to save memory.

For tf-idf, bm25, bm25+ you could chose the log-base and how the term-frequency (TF) and the inverse document frequency (IDF) are computed.

Installation and usage

To install:

pip install similaripy

Basic usage:

import similaripy as sim
import scipy.sparse as sps

# create a random user-rating matrix (URM)
urm = sps.random(1000, 2000, density=0.025)

# normalize matrix with bm25
urm = sim.normalization.bm25(urm)

# train the model with 50 knn per item 
model = sim.cosine(urm.T, k=50)

# recommend 100 items to users 1, 14 and 8 filtering the items already seen by each users
user_recommendations = sim.dot_product(urm, model.T, k=100, target_rows=[1,14,8], filter_cols=urm)

Requirements

Package Version
numpy >= 1.14
scipy >= 1.0.0
tqdm >= 4.19.6
cython >= 0.28.1

NOTE: In order to compile the Cython code it is required a GCC compiler with OpenMP (on OSX it can be installed with homebrew: brew install gcc).

This library has been tested with Python 3.6 on Ubuntu, OSX and Windows.

(Note: on Windows there are problem with flag format_output='csr', just let it equals to the default value 'coo')

Optimal Configuration

I recommend configuring SciPy/Numpy to use Intel's MKL matrix libraries. The easiest way of doing this is by installing the Anaconda Python distribution.

Future work

I plan to release in the next future some utilities:

  • Utilities for sparse matrices
  • New similarity functions ( good ideas are welcome :) )

History

The idea of build this library comes from the RecSys Challenge 2018 organized by Spotify.

My team, the Creamy Fireflies, had problem in compute very huge similarity models in a reasonable time (66 million of interactions in the user-rating matrix) and using python and numpy were not suitable since a full day was required to compute one single model.

As a member of the the team I spent a lot of hours to develop these high-performance similarities in Cython to overcome the problem. At the end of the competition, pushed by my team friends, I decide to release my work to help people that one day will encounter our same problem.

Thanks to my Creamy Fireflies friends for support me.

License

Released under the MIT License

Citation information: DOI_PIC

@misc{boglio_simone_similaripy,
  author       = {Boglio Simone},
  title        = {bogliosimone/similaripy},
  doi          = {10.5281/zenodo.2583851},
  url          = {https://doi.org/10.5281/zenodo.2583851}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for similaripy, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size similaripy-0.1.1-cp37-cp37m-macosx_10_7_x86_64.whl (704.1 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size similaripy-0.1.1.tar.gz (334.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page