User Guide

Welcome to the LensKit user guide! These documents provide a topical guide to how to use LensKit for research, education, and other purposes.

Preliminaries

• Installing LensKit
• Getting Started
• Examples
• Migrating from LensKit 0.x

Fundamentals

• Design Goals and Principles
• Queries and Operations
• Recommendation Pipelines

Data

• Datasets
• Data Model
• Item Lists and Collections
• Standard Datasets

Components and Models

• Component Conventions
• Scoring Models
• Flexible Matrix Factorization
• Ranking Algorithms
• Other Components
• Implementing Components

Experiments

• Splitting Data
• Batch-Running Pipelines
• Evaluating Recommender Output
• Collecting and Aggregating Metrics
• Documenting Experiments

Utilities and Diagnostics

• Logging and Progress Reporting
• LensKit Diagnostics
• Parallel Processing
• LensKit CLI