Metadata-Version: 2.4
Name: rtrec
Version: 0.1.3
Summary: An realtime recommendation system supporting online updates
Project-URL: homepage, https://github.com/myui/rtrec
Project-URL: repository, https://github.com/myui/rtrec
Author-email: myui <myui@apache.org>
License-File: LICENSE
Keywords: machine learning,personalization,recommendation systems,recommender,recsys
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: boto3<2.0.0,>=1.20.0
Requires-Dist: fastapi<1.0.0,>=0.70.0
Requires-Dist: httpx<1.0.0,>=0.20.0
Requires-Dist: implicit<1.0.0,>=0.6.0
Requires-Dist: numpy<3.0.0,>=1.21.0
Requires-Dist: optuna<5.0.0,>=3.0.0
Requires-Dist: pandas<3.0.0,>=1.3.0
Requires-Dist: pydantic<3.0.0,>=1.10.0
Requires-Dist: rectools-lightfm<2.0.0,>=1.17.3
Requires-Dist: scipy<2.0.0,>=1.5.0
Requires-Dist: tqdm<5.0.0,>=4.60.0
Requires-Dist: uvicorn<1.0.0,>=0.18.0
Description-Content-Type: text/markdown

rtrec: Realtime Recommendation Library in Python
================================================

[![PyPI version](https://img.shields.io/pypi/v/rtrec.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/rtrec/)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/rtrec.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/rtrec/)
[![CI status](https://github.com/myui/rtrec/actions/workflows/ci.yml/badge.svg)](https://github.com/myui/rtrec/actions)
[![Licence](https://img.shields.io/github/license/myui/rtrec.svg)](LICENSE.txt)

An realtime recommendation system supporting online updates.

## Highlights

- ❇️ Supporting online updates.
- ⚡️ Fast implementation (>=190k samples/sec training on laptop).
- ◍ efficient sparse data support.
- 🕑 decaying weights of user-item interactions based on recency.
- ![Rust](https://avatars.githubusercontent.com/u/5430905?s=20&v=4) experimental [Rust implementation](https://github.com/myui/rtrec/tree/rust)

## Supported Recommendation Algorithims

- Sparse [SLIM](https://ieeexplore.ieee.org/document/6137254) with [time-weighted](https://dl.acm.org/doi/10.1145/1099554.1099689) interactions.
- [Factorization Machines](https://ieeexplore.ieee.org/document/5694074) using [LightFM](https://github.com/lyst/lightfm) (to appear)

## Installation

```bash
pip install rtrec
```

## Usage

Find usages in [notebooks](https://github.com/myui/rtrec/tree/main/notebooks)/[examples](https://github.com/myui/rtrec/tree/main/examples).
