API Reference

This section provides detailed API documentation for the genrec framework.

Core Modules

Models

• RQVAE: Residual Quantized Variational Autoencoder
• TIGER: Transformer-based generative retrieval model

Data Processing

• Base Dataset: Abstract base classes for datasets
• Configurations: Configuration management classes
• Processors: Text and sequence processing utilities
• Dataset Factory: Factory pattern for dataset creation

Training

• Trainers: Training utilities and scripts
• Modules: Core building blocks (encoders, losses, metrics)

Quick Navigation

Core Components

Models: - RQVAE Model Class - Vector quantized variational autoencoder - TIGER Model Class - Transformer-based generative retrieval

Data Processing: - Dataset Classes - Data loading and preprocessing - Configuration System - Parameter management - Processors - Text and sequence processing utilities

Training: - RQVAE Training - Training procedures and configuration - TIGER Training - Advanced training workflows

Code Examples

See the Examples page for practical usage patterns and code snippets.