Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Abacus 2.1 documentation
Abacus 2.1 documentation

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)
      • Base (base.py)
      • Build (build.py)
      • Constants (consts.py)
      • Decomposition (decomp.py)
      • Abacus Core: Decomposition (_decomp.py)
      • Lift Test Integration (lift_test.py)
      • Model (model.py)
      • MMM Base (mmm_base.py)
      • MMM Model (mmm_model.py)
      • Optimization (opt.py)
      • Transformers (transformers.py)
      • Core Utilities (utils.py)
      • Abacus Core: Legacy Imports (_legacy_imports.py)
      • Abacus Core Mixins: Contribution (contribution.py)
      • Abacus Core Mixins: Diagnostics (diagnostics.py)
      • Abacus Core Mixins: MMM Analysis (mmm_analysis.py)
      • Abacus Core Mixins: MMM Calibrate (mmm_calibrate.py)
      • Abacus Core Mixins: MMM Predict (mmm_predict.py)
      • Abacus Core Mixins: Optimization (optimization.py)
      • Abacus Core Mixins: Plotting Contribution (plotting_contribution.py)
      • Abacus Core Mixins: Plotting Parameter (plotting_parameter.py)
      • Abacus Core Mixins: Plotting Predictive (plotting_predictive.py)
      • Abacus Core Mixins: Plotting Scenario (plotting_scenario.py)
    • Driver Package (abacus.driver)
      • Driver (driver.py)
      • Abacus Driver: Budget Optimisation (opt.py)
      • _assess Module (Internal)
      • _desc Module (Internal Script/Notes)
      • _dl Module (Internal Colab Utility)
      • _driver Module (Internal Workflow Definition)
      • _opt Module (Internal Script/Notes)
      • _run Module (Internal Script)
      • _valid Module (Internal Script/Notes)
    • Preprocessing Package (abacus.prepro)
      • Abacus Preprocessing: Configuration (config.py)
      • Abacus Preprocessing: Convert (convert.py)
      • Data To Fit (data_to_fit.py)
      • Abacus Preprocessing: Decode (decode.py)
      • Abacus Preprocessing: Directory (dir.py)
      • Input Data (input_data.py)
      • Abacus Preprocessing: Outliers (outliers.py)
      • Abacus Preprocessing: Preprocessing (prepro.py)
      • Abacus Preprocessing: Scaler (scaler.py)
      • Abacus Preprocessing: Seasonality (seas.py)
      • Abacus Preprocessing: Validation (valid.py)
      • _config Module (Internal)
    • Sketch Package (abacus.sketch)
      • Abacus Sketch: Depict (depict.py)
      • Abacus Sketch: Plot Diagnostics (plot_diagnostics.py)
      • Abacus Sketch: Plot Input (plot_input.py)
      • Abacus Sketch: Plot Results (plot_results.py)
      • _depict Module (Internal)
      • _plot Module (Internal)
    • Diagnostics Package (abacus.diagnostics)
      • Abacus Diagnostics: Input Validator (input_validator.py)
  • Troubleshooting Guide
  • Testing
Back to top
View this page

Getting StartedΒΆ

This section provides tutorials to help you get started with the Abacus library.

Getting Started:

  • Installation Guide
  • Quickstart
  • Data Preparation Guide

  • Installation: How to install the library and its dependencies.

  • Quickstart: A basic end-to-end example of running an MMM.

  • Data Preparation: Guide on formatting your input data correctly.

Next
Installation Guide
Previous
Home
Copyright © 2025, Charles Shaw
Made with Sphinx and @pradyunsg's Furo