API Reference

This section is a hand-curated reference for the retained public Abacus API.

It focuses on stable entry points that users are expected to import directly. It does not try to document every internal module under abacus.mmm.models, abacus.mmm.summarization, or abacus.pipeline.stages.

For task-oriented workflows, use the main documentation sections first. Use this reference when you need the exact import path, object name, or the scope of a public surface.

Main module groups

Module Primary public surface
abacus.mmm.panel PanelMMM
abacus.mmm Adstock, saturation, Fourier, HSGP, and trend classes
abacus.mmm.optimization PanelBudgetOptimizerWrapper and advanced optimisation helpers
abacus.mmm.builders.yaml build_mmm_from_yaml(...)
abacus.pipeline PipelineRunConfig, run_pipeline(...), PipelineRunResult
abacus.scenarios Scenario specs, ScenarioPlanner, ScenarioComparison, and versioned result payloads
abacus.scenario_planner Legacy compatibility imports and advisory dashboard app-layer facades
abacus.data.idata MMMIDataWrapper, schema helpers, and idata utilities

Pages

  • PanelMMM: Core model import path, constructor surface, lifecycle methods, and bound properties.
  • Post-Fit Facades: mmm.data, mmm.summary, mmm.diagnostics, mmm.plot, and direct factory imports.
  • Transforms and Supporting Types: Adstock, saturation, Fourier, HSGP, trend, and scaling types.
  • Optimisation API: PanelBudgetOptimizerWrapper and the exported advanced optimisation helpers.
  • Builders and Pipeline: YAML builder, structured pipeline entry points, and run result objects.
  • Scenario Planner API: Scenario spec classes, planner service objects, versioned payloads, and compatibility dashboard entry points.
  • Additive Effects and Events: Advanced extension points for mu_effects and dated event modelling.