.. RecBole documentation master file.

RecBole v0.1.2
=========================================================

`HomePage <https://recbole.io/>`_ | `Docs <https://recbole.io/docs/>`_ | `GitHub <https://github.com/RUCAIBox/RecBole>`_ | `Datasets <https://github.com/RUCAIBox/RecDatasets>`_

.. toctree::
   :maxdepth: 1
   :caption: Get Started

   get_started/introduction
   get_started/install
   get_started/quick_start

.. toctree::
   :maxdepth: 1
   :caption: User Guide

   user_guide/config_settings
   user_guide/data_intro
   user_guide/model_intro
   user_guide/evaluation_support
   user_guide/usage


.. toctree::
   :maxdepth: 1
   :caption: Developer Guide

   developer_guide/customize_models
   developer_guide/customize_trainers
   developer_guide/customize_dataloaders
   developer_guide/customize_samplers


.. toctree::
   :maxdepth: 1
   :caption: API REFERENCE:

   recbole/recbole.config
   recbole/recbole.data
   recbole/recbole.evaluator
   recbole/recbole.model
   recbole/recbole.quick_start.quick_start
   recbole/recbole.sampler.sampler
   recbole/recbole.trainer.hyper_tuning
   recbole/recbole.trainer.trainer
   recbole/recbole.utils.enum_type
   recbole/recbole.utils.logger
   recbole/recbole.utils.utils


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`