Install RecBole

RecBole can be installed from pip, Conda and source.


System requirements

RecBole works with the following operating systems:

  • Linux
  • Windows 10
  • macOS X

RecBole requires Python version 3.6 or later.

RecBole requires torch version 1.7.0 or later. If you want to use RecBole with GPU, please ensure that CUDA or CUDAToolkit version is 9.2 or later. This requires NVIDIA driver version >= 396.26 (for Linux) or >= 397.44 (for Windows10).


Install from Conda

If Conda is not yet installed in your system environment, get either Miniconda or the full Anaconda. If you are in China, Tsinghua Mirrors is recommended to install Conda.

With Conda installed, you can install RecBole with Python 3.6 Conda environment. Run conda create -n recbole python=3.6 to create the environment. Activate the environment by running conda activate recbole. After the Conda environment is activated, run the following command to install RecBole:

conda install -c aibox recbole

Install from pip

To install RecBole from pip, you need to run this command:

pip install recbole

Install from source

Download the source files from GitHub.

git clone https://github.com/RUCAIBox/RecBole.git && cd RecBole

Run the following command to install:

pip install -e . --verbose

You can read the Quick Start to get more information about quick starting.