Abacus Documentation

Welcome to the documentation for the Abacus Marketing Mix Modelling (MMM) library.

Abacus provides a comprehensive framework for building, analysing, and optimising MMMs using Bayesian methods with PyMC.

Contents:

• Getting Started
  • Installation Guide
  • Quickstart
  • Data Preparation Guide
• How-to Guides
  • Guide: Configuring the Model Run
  • Guide: Running the Model
  • Guide: Interpreting Model Results
  • Guide: Performing Budget Optimisation
  • Guide: Performing Cross-Validation and Model Evaluation
  • Guide: Prior Calibration using Historical Data
  • Guide: Lift Test Calibration
• Explanation
  • Explanation: Core MMM Methodology
  • Explanation: Model Components
  • Explanation: Leave-One-Out Cross-Validation (LOO-CV)
  • Comparison with Other MMM Libraries
  • Explanation: Optimisation Concepts
• API Reference
  • Abacus Library API
  • Configuration Reference
  • Reference: Output Files
  • Core Package (abacus.core)
  • Driver Package (abacus.driver)
  • Preprocessing Package (abacus.prepro)
  • Sketch Package (abacus.sketch)
  • Diagnostics Package (abacus.diagnostics)
• Troubleshooting Guide
  • Common Errors
  • Performance Issues
  • Debugging Tips
  • Frequently Asked Questions (FAQ)
• Testing
  • Test Structure
  • Running Tests
  • Writing Tests
  • Test Coverage

Documentation Structure

This documentation is organised into four main sections based on the Diátaxis framework:

1. Getting Started: Tutorials for new users, covering installation, data preparation, and running a basic model.

2. How-to Guides: Practical step-by-step guides for accomplishing specific tasks, such as configuring the model, interpreting results, and performing optimisation.

3. Explanation: Conceptual discussions explaining the underlying methodology, model components, and statistical concepts.

4. Reference: Technical details, including the API reference, configuration parameter definitions, and output file descriptions.

5. Troubleshooting: Solutions for common errors, performance tips, and debugging strategies.

6. Testing: Information on running the test suite, understanding test structure, and contributing tests.