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
      • Leave-Last-Out Checkpoint
      • Temporal Checkpoint
    • Checkpoint Split Schema
    • Builder Parameters
    • Supported Amazon Reviews 2023 Datasets

API Reference

  • API Reference
    • Core API
      • Datasets
        • SplitBundle
        • RecSysDataset
        • Goodbooks
        • MovieLens1M
        • MovieLens20M
        • AmazonReviews2023
      • Checkpoint Helpers
        • build_recsys_checkpoint()
        • update_checkpoint()
        • read_checkpoint()
        • load_manifest()
        • save_manifest()
        • update_stage_manifest()
        • save_json()
        • load_json()
        • save_recsys_split()
        • load_recsys_split()
        • save_cluster_graph_stage()
        • load_cluster_graph_stage()
      • Retrieval API
        • build_eval_holdout()
        • build_item_cold_holdout()
        • build_leave_last_out_holdout()
        • build_temporal_holdout()
        • evaluate_item_embeddings()
        • evaluate_item_embeddings_with_holdout()
    • Datasets API
    • Checkpoint API
      • Checkpoint Contexts
      • Manifest and JSON Helpers
      • Split and Cluster Stages
    • Retrieval API
      • Holdout Builders
        • build_eval_holdout()
        • build_item_cold_holdout()
        • build_leave_last_out_holdout()
        • build_temporal_holdout()
      • Embedding Evaluation
        • evaluate_item_embeddings()
        • evaluate_item_embeddings_with_holdout()
Compresso Recsys
  • Search

© Copyright .

Built with Sphinx using a theme provided by Read the Docs.