Welcome to Compresso Recsys's documentation!
============================================

Compresso Recsys is the recommender-system companion package for Compresso. It
contains dataset loaders, checkpoint-building utilities, checkpoint read/write
helpers, and retrieval metrics used to demonstrate sparse representation
learning.

The project distribution is named ``compresso-recsys`` and the Python package
is imported as ``compresso_recsys``.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation
   getting-started
   quickstart

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   examples
   datasets
   bring-your-own-dataset
   implementing-a-recommender
   reproducing-sasrec-results-on-ml1m
   
   statistical-comparison
   citing
   cli-reference

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/index

Indices and Tables
==================

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