API Reference

Welcome to the ABACUS API Reference. This section provides detailed documentation for the various packages and modules within the ABACUS library.

Reference:

• Abacus Library API
  • Overview
• Configuration Reference
  • File Structure Overview
  • Parameter Details
• Reference: Output Files
  • Configuration and Summary Files
  • Core Model Output & Data
  • Visualisations (.png files)
  • Derived Metrics
• 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)

The reference documentation is organized mirroring the structure of the abacus Python package. Choose a package below to explore its modules and components:

• Core: Fundamental building blocks, models, transformations, and optimization logic.

• Driver: High-level interfaces and orchestration for running ABACUS workflows.

• Preprocessing: Tools for data loading, cleaning, transformation, and preparation.

• Sketch: Utilities for plotting, visualization, and diagnostics.

• Diagnostics: Tools for model validation and input checking.

Each subdirectory contains detailed Markdown files corresponding to the Python modules within that package.