API Reference
This section is a hand-curated reference for the retained public ammm API.
It focuses on stable entry points that users are expected to import directly.
It does not try to document every internal module under ammm.mmm.models,
ammm.mmm.summarization, or ammm.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 |
|---|---|
ammm.mmm.panel | PanelMMM |
ammm.mmm | Adstock, saturation, Fourier, HSGP, and trend classes |
ammm.mmm.optimization | PanelBudgetOptimizerWrapper and advanced optimisation helpers |
ammm.mmm.builders.yaml | build_mmm_from_yaml(...) |
ammm.pipeline | PipelineRunConfig, run_pipeline(...), PipelineRunResult |
ammm.scenarios | Scenario specs, ScenarioPlanner, ScenarioComparison, and versioned result payloads |
ammm.scenario_planner | Statistical scenario implementation and shared types |
ammm.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:
PanelBudgetOptimizerWrapperand 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 and versioned payloads.
Additive Effects and Events: Advanced extension points for
mu_effectsand dated event modelling.Special Priors covers positive-scale, Laplace and masked variable factories.
Scenario Workspaces and IDE Protocol covers persistence, revisions, jobs and JSON request contracts.
Prior Sensitivity and Advisor APIs covers configuration expansion, evidence review and approved-patch files.
Recommended starting points
- If you are building and fitting a model in code, start with PanelMMM.
- If you are reading fitted outputs, start with Post-Fit Facades.
- If you are building from YAML or running the structured runner, start with Builders and Pipeline.
- If you are comparing plans, start with Scenario Planner API.