Development

Documentation

Documentation lives in librec_auto/docs/, and is hosted on Read the Docs.

To rebuild the docs:

  1. cd librec_auto/docs/
  2. make clean && make html.

Building from Source

Instead of installing librec_auto from pip, you can also build it from the source.

First, you’ll need to clone this repository:

$ git clone https://github.com/that-recsys-lab/librec-auto.git && cd librec-auto

Then, run the setup script with the develop command:

$ python setup.py develop

This will make any edits you make to the librec-auto library take effect immediately, without needing to re-install librec-auto every time you make a change.

Code Formatting

We use Yapf for python code formatting. To format the whole codebase, run:

yapf . -i --recursive

Docker

You can develop librec_auto in Docker.

The root-level Dockerfile only installs librec_auto. It does not actually run any experiments. You can extend this file with your own code to further develop librec_auto.

To use the Dockerfile, run the following in your bash terminal:

docker build -t librec_auto:latest .
docker run librec_auto:latest