The librec-auto project aims to automate recommender system experiments using LibRec.
Project description
============ Librec-auto
.. image:: https://coveralls.io/repos/github/that-recsys-lab/librec-auto/badge.svg?branch=master :target: https://coveralls.io/github/that-recsys-lab/librec-auto?branch=master
About
librec-auto
is a Python tool for running recommender systems experiments.
It is built on top of the open-source LibRec_ package, and
can take advantage of the many algorithm and metric implementations there.
.. _LibRec: https://github.com/guoguibing/librec
The basic element of librec-auto
execution is the "study", which is a series
of experiments carried with a single algorithm, a single data set, and a set
of evaluation metrics. The experiments differ from each other by the hyperparameters
given to the algorithm. librec-auto
allows such studies to be conducted with
minimal experimenter intervention, and supports such capabilities as:
- recommendation result re-ranking
- re-running evaluations without re-computing results
- fairness-aware metrics
- summarizing results in output graphs
- integration with Slack and Dropbox
More complete documentation is available at readthedocs_:
.. _readthedocs: https://librec-auto.readthedocs.io/en/latest/index.html
Workflow
The workflow of an study involves identifying appropriate data, creating training / test splits, implementing or choosing algorithms, running experiments (possibly with a range of different parameters), and reporting on the results.
Configuration
Librec-auto uses an XML-based configuration system similar to Maven or Ant.
Project structure
This directory contains the Python libraries for the librec_auto module. There are two other affiliated respositories:
librec-auto-java
_: Contains the java source for the wrapper between LibRec and librec-auto, which is implemented in theauto.jar
file.librec-auto-demo2021
_: Contains sample data and configuration files that can be used to explore the functionality of librec-auto
.. _librec-auto-java: https://github.com/that-recsys-lab/librec-auto-java .. _librec-auto-sample: https://github.com/that-recsys-lab/librec-auto-demo2021
Repo structure
/bin
: Contains auxiliary scripts including the study setup wizard./librec_auto/jar
: Contains the jar files for LibRec and the wrapper./librec_auto/rules
: Contains the rules for translating configuration data to LibRec properties format./librec_auto/core
: Contains the Python code for the project./librec_auto/docs
: Contains documentation for the project/librec_auto/test
: Contains the unit tests (not many right now)/librec_auto/library
: Contains libraries of configuration information (look hear to see how to configure different algorithms)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for librec_auto-0.2.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0586e2bed5533a71955f04013237f9d4f8f89ac306cd9858466bd9c2da561ee7 |
|
MD5 | 32e1e797291b0b1874c26bda74bd4e78 |
|
BLAKE2b-256 | 5e7c7d9535eb17ed26723d48754ce8de8ddde07ccc262444ed7ef387f5b50dab |