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.

Getting Started

• Installation
  • Install from PyPI
  • Optional Extras
  • Local Development
  • Install from GitHub
  • Build the Documentation Locally
• Getting Started
  • Basic Python Usage
  • Checkpoint Workflow
  • What Goes Into a Checkpoint
  • Split Modes
  • Retrieval Metrics
• Quickstart
  • Choose a Split Mode

User Guide

• Examples
  • Dataset Loader
  • Building Checkpoints
  • Checkpoint Read/Write
  • Evaluate Embeddings From Python
• Checkpoint CLI Reference
  • Amazon Reviews 2023
  • Checkpoint Split Schema
  • Builder Parameters
  • Supported Amazon Reviews 2023 Datasets

API Reference

• API Reference
  • Core API
  • Datasets API
  • Checkpoint API
  • Retrieval API

Indices and Tables

• Index

• Module Index

• Search Page