Change baseline_intercept to intercept_baseline for consistent prefix (#1529)

* changed baseline_intercept to intercept_baseline for consistency

* updated notebook to reference intecept_baseline

* fixed typo in notebook code example

---------

Co-authored-by: Will Dean <57733339+wd60622@users.noreply.github.com>
Co-authored-by: Juan Orduz <juanitorduz@gmail.com>
Co-authored-by: Will Dean <57733339+williambdean@users.noreply.github.com>

Author: 3 people

docs/source/notebooks/mmm/mmm_tvp_example.ipynb

@@ -691,7 +691,7 @@
         },
         {
             "cell_type": "code",
-            "execution_count": 9,
+            "execution_count": null,
             "metadata": {},
             "outputs": [
                 {
@@ -707,7 +707,7 @@
                 "    print(\n",
                 "        \"base_intercept:\",\n",
                 "        float(\n",
-                "            mmm.idata.posterior.baseline_intercept.mean()\n",
+                "            mmm.idata.posterior.intercept_baseline.mean()\n",
                 "            * mmm.target_transformer.steps[0][1].scale_[0]\n",
                 "        ),\n",
                 "    )\n",

pymc_marketing/mmm/mmm.py

@@ -146,7 +146,7 @@ def __init__(
         time_varying_intercept : bool, optional
             Whether to consider time-varying intercept, by default False.
             Because the `time-varying` variable is centered around 1 and acts as a multiplier,
-            the variable `baseline_intercept` now represents the mean of the time-varying intercept.
+            the variable `intercept_baseline` now represents the mean of the time-varying intercept.
         time_varying_media : bool, optional
             Whether to consider time-varying media contributions, by default False.
             The `time-varying-media` creates a time media variable centered around 1,
@@ -501,8 +501,8 @@ def build_model(
                 )
 
             if self.time_varying_intercept:
-                baseline_intercept = self.model_config["intercept"].create_variable(
-                    "baseline_intercept"
+                intercept_baseline = self.model_config["intercept"].create_variable(
+                    "intercept_baseline"
                 )
 
                 intercept_latent_process = create_time_varying_gp_multiplier(
@@ -515,7 +515,7 @@ def build_model(
                 )
                 intercept = pm.Deterministic(
                     name="intercept",
-                    var=baseline_intercept * intercept_latent_process,
+                    var=intercept_baseline * intercept_latent_process,
                     dims="date",
                 )
             else:

pymc_marketing/mmm/multidimensional.py

@@ -966,8 +966,8 @@ def build_model(
 
             # Add intercept logic
             if self.time_varying_intercept:
-                baseline_intercept = self.model_config["intercept"].create_variable(
-                    "baseline_intercept"
+                intercept_baseline = self.model_config["intercept"].create_variable(
+                    "intercept_baseline"
                 )
 
                 intercept_latent_process = SoftPlusHSGP.parameterize_from_data(
@@ -978,7 +978,7 @@ def build_model(
 
                 intercept = pm.Deterministic(
                     name="intercept_contribution",
-                    var=baseline_intercept[None, ...] * intercept_latent_process,
+                    var=intercept_baseline[None, ...] * intercept_latent_process,
                     dims=("date", *self.dims),
                 )
             else: