API Reference

The API reference documents the public objects exported by compresso_recsys and its public dataset, checkpoint, sequence, model, retrieval, metric, evaluation, and statistics submodules.

• Core API
  • Datasets
  • Checkpoint Helpers
• Datasets API
  • DBbook
  • LastFM2K
• Checkpoint API
  • Item embeddings
  • Checkpoint Contexts
  • Manifest and JSON Helpers
  • Split and Cluster Stages
• Fitted Model Persistence
  • Embedding Models in Data Checkpoints
  • Stable Item IDs
  • Optimizer State
  • Checkpoint Format
  • Extending Persistence
  • Warm Catalog Adapters
• Sequences API
  • Interaction Histories
  • Which Split Modes Produce Them
• Models API
  • Recommender Contract
  • Production Recommendations
  • Training and Prediction Progress
  • Fitted Model Persistence
  • Implementing New Models
  • Transductive Models in Expanding Catalogs
  • Collaborative Filtering Models
  • Cold-Start Models
  • Sequential Models
• Retrieval API
  • Holdout Builders
  • Embedding Evaluation
• Ranking Evaluation API
  • Predictions and Targets
  • Evaluation Results
  • Custom Metrics
  • Metrics
• Statistics API
  • Comparison Functions
  • Results
  • Parameter Values