MMM Report

pymc_marketing/mmm/__init__.py

@@ -65,6 +65,7 @@
     preprocessing_method_X,
     preprocessing_method_y,
 )
+from pymc_marketing.mmm.report import MMMReport
 from pymc_marketing.mmm.scaling import (
     DataDerivedScaling,
     FixedScaling,
@@ -98,6 +99,8 @@
     "LinearTrend",
     "LogisticSaturation",
     "MMMBuilder",
+    "MMMModelBuilder",
+    "MMMReport",
     "MediaConfig",
     "MediaConfigList",
     "MediaTransformation",

pymc_marketing/mmm/report/__init__.py

@@ -0,0 +1,35 @@
+#   Copyright 2022 - 2026 The PyMC Labs Developers
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+"""MMM report generation utilities.
+
+This package provides :class:`MMMReport`, a high-level interface for
+generating standardized reports from a fitted Media Mix Model.  Reports
+can be exported to HTML, PDF, or Excel.
+"""
+
+from pymc_marketing.mmm.report._contracts import (
+    ReportConfig,
+    ReportData,
+    ReportMetadata,
+    ReportSection,
+)
+from pymc_marketing.mmm.report._report import MMMReport
+
+__all__ = [
+    "MMMReport",
+    "ReportConfig",
+    "ReportData",
+    "ReportMetadata",
+    "ReportSection",
+]