MMM Component Notebook (#748)

* initial notebook

* add to example

* push up some feedback

* change the number of channels

* updates

* final message

* add more feedback

* remove since wasnt working the way I wanted

docs/source/notebooks/index.md

@@ -10,6 +10,7 @@ mmm/mmm_example
 mmm/mmm_budget_allocation_example
 mmm/mmm_lift_test
 mmm/mmm_tvp_example
+mmm/mmm_components
 :::
 
 :::{toctree}

tests/mmm/components/test_base.py

@@ -282,7 +282,7 @@ def test_selections(coords, expected) -> None:
     assert list(selections(coords)) == expected
 
 
-def test_change_instance_function_priors_has_no_impact(
+def test_change_instance_function_priors_has_no_impact_new_instance(
     new_transformation_class,
 ) -> None:
     """What happens in the MMM logic."""
@@ -297,3 +297,17 @@ def test_change_instance_function_priors_has_no_impact(
         "a": {"dist": "HalfNormal", "kwargs": {"sigma": 1}},
         "b": {"dist": "HalfNormal", "kwargs": {"sigma": 1}},
     }
+
+
+def test_change_instance_function_priors_has_no_impact_on_class(
+    new_transformation_class,
+) -> None:
+    instance = new_transformation_class()
+
+    for _, config in instance.function_priors.items():
+        config["dims"] = "channel"
+
+    assert new_transformation_class.default_priors == {
+        "a": {"dist": "HalfNormal", "kwargs": {"sigma": 1}},
+        "b": {"dist": "HalfNormal", "kwargs": {"sigma": 1}},
+    }

tests/mmm/test_delayed_saturated_mmm.py

@@ -1050,3 +1050,18 @@ def test_initialize_alternative_with_classes() -> None:
     assert isinstance(mmm.adstock, DelayedAdstock)
     assert mmm.adstock.l_max == 10
     assert isinstance(mmm.saturation, MichaelisMentenSaturation)
+
+
+def test_initialize_defaults_channel_media_dims() -> None:
+    mmm = MMM(
+        date_column="date",
+        channel_columns=["channel_1", "channel_2"],
+        adstock_max_lag=4,
+        control_columns=["control_1", "control_2"],
+        adstock=DelayedAdstock(l_max=10),
+        saturation=MichaelisMentenSaturation(),
+    )
+
+    for transform in [mmm.adstock, mmm.saturation]:
+        for config in transform.function_priors.values():
+            assert config["dims"] == "channel"