Add FrequencyReachAdditiveEffect

pymc_marketing/mmm/__init__.py

@@ -14,6 +14,10 @@
 """Marketing Mix Models (MMM)."""
 
 from pymc_marketing.mmm import preprocessing, validating
+from pymc_marketing.mmm.additive_effect import (
+    RF_CHANNEL_COORD,
+    FrequencyReachAdditiveEffect,
+)
 from pymc_marketing.mmm.components.adstock import (
     AdstockTransformation,
     BinomialAdstock,
@@ -27,6 +31,7 @@
 from pymc_marketing.mmm.components.saturation import (
     HillSaturation,
     HillSaturationSigmoid,
+    HillShapeSaturation,
     InverseScaledLogisticSaturation,
     LogisticSaturation,
     LogSaturation,
@@ -84,6 +89,7 @@
 __all__ = [
     "HSGP",
     "MMM",
+    "RF_CHANNEL_COORD",
     "AdstockTransformation",
     "BinomialAdstock",
     "BudgetOptimizerWrapper",
@@ -92,10 +98,12 @@
     "DelayedAdstock",
     "FancyLinearRegression",
     "FixedScaling",
+    "FrequencyReachAdditiveEffect",
     "GeometricAdstock",
     "HSGPPeriodic",
     "HillSaturation",
     "HillSaturationSigmoid",
+    "HillShapeSaturation",
     "InverseScaledLogisticSaturation",
     "LinearTrend",
     "LogSaturation",

pymc_marketing/mmm/additive_effect/__init__.py

@@ -0,0 +1,48 @@
+#   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.
+"""
+Additive effects submodule.
+
+This submodule provides classes for modeling additive effects within the PyMC Marketing Mix Modeling (MMM) framework.
+
+It exposes the following components:
+    - Model: The main class for specifying additive effect models.
+    - MuEffect: A class representing the mean effect in additive models.
+
+Typical usage involves importing these classes to construct and analyze additive effect models in marketing analytics.
+"""
+
+from pymc_marketing.mmm.additive_effect.additive_effect import (
+    EventAdditiveEffect,
+    FourierEffect,
+    LinearTrendEffect,
+    Model,
+    MuEffect,
+    safe_to_datetime,
+)
+from pymc_marketing.mmm.additive_effect.frequency_reach_effect import (
+    RF_CHANNEL_COORD,
+    FrequencyReachAdditiveEffect,
+)
+
+__all__ = [
+    "RF_CHANNEL_COORD",
+    "EventAdditiveEffect",
+    "FourierEffect",
+    "FrequencyReachAdditiveEffect",
+    "LinearTrendEffect",
+    "Model",
+    "MuEffect",
+    "safe_to_datetime",
+]