Remove Prior classes and functions from pymc_marketing.prior module (#2060)

* Initial plan

* Remove deprecated functions and classes from prior module

- Removed deprecated class wrappers: Prior, Censored, Scaled
- Removed deprecated function wrappers: sample_prior, create_dim_handler, handle_dims, register_tensor_transform
- Removed deprecation warning decorators
- Removed unused imports (functools, warnings)
- Kept alternative serialization functionality (is_alternative_prior, deserialize_alternative_prior)
- Updated imports in test_fourier.py and Fourier_Seasonality.py to use pymc_extras.prior
- Removed deprecation tests from test_prior.py

Co-authored-by: williambdean <57733339+williambdean@users.noreply.github.com>

* Fix import ordering in Fourier_Seasonality.py

Co-authored-by: williambdean <57733339+williambdean@users.noreply.github.com>

* Update nested_logit notebook to use pymc_extras.prior

Co-authored-by: williambdean <57733339+williambdean@users.noreply.github.com>

* Fix end-of-file in nested_logit.ipynb for pre-commit lint

Co-authored-by: juanitorduz <22996444+juanitorduz@users.noreply.github.com>

* Fix import ordering in nested_logit.ipynb for ruff pre-commit

Co-authored-by: juanitorduz <22996444+juanitorduz@users.noreply.github.com>

* Fix test_prior.py by restoring import of pymc_marketing.prior

The import is needed to trigger registration of the alternative prior deserializer.
Without it, the deserialize() function doesn't know how to handle dict-based prior specifications.

Co-authored-by: juanitorduz <22996444+juanitorduz@users.noreply.github.com>

* Update tests/test_prior.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Fix import formatting in test_prior.py for ruff compliance

Ruff requires imports to be properly grouped and formatted. The local import
was reformatted into a multi-line format for consistency.

Co-authored-by: juanitorduz <22996444+juanitorduz@users.noreply.github.com>

* Ensure deserializer registration on pymc_marketing import

Added import of pymc_marketing.prior in the main __init__.py to ensure
the alternative prior deserializer is registered when users import
pymc_marketing or pymc_marketing.mmm. This makes the deserializer
available for YAML-based configurations without requiring explicit
import of the prior module.

Co-authored-by: williambdean <57733339+williambdean@users.noreply.github.com>

* Revert "Ensure deserializer registration on pymc_marketing import"

This reverts commit 0adb6c4.

The import of pymc_marketing.prior in __init__.py is not needed since
the deserializer is already registered via pymc_marketing/mmm/builders/factories.py
when using YAML-based configurations.

Co-authored-by: williambdean <57733339+williambdean@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: williambdean <57733339+williambdean@users.noreply.github.com>
Co-authored-by: juanitorduz <22996444+juanitorduz@users.noreply.github.com>
Co-authored-by: Juan Orduz <juanitorduz@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 4 people

docs/source/notebooks/customer_choice/nested_logit.ipynb

@@ -28,10 +28,10 @@
     "import arviz as az\n",
     "import matplotlib.pyplot as plt\n",
     "import pandas as pd\n",
+    "from pymc_extras.prior import Prior\n",
     "\n",
     "from pymc_marketing.customer_choice.nested_logit import NestedLogit\n",
-    "from pymc_marketing.paths import data_dir\n",
-    "from pymc_marketing.prior import Prior"
+    "from pymc_marketing.paths import data_dir"
    ]
   },
   {

pymc_marketing/prior.py

@@ -103,8 +103,6 @@ def custom_transform(x):
 from __future__ import annotations
 
 import copy
-import functools
-import warnings
 from typing import Any
 
 from pymc_extras import prior
@@ -162,70 +160,3 @@ def deserialize_alternative_prior(data: dict[str, Any]) -> prior.Prior:
 
 # Register the alternative prior deserializer for more complex nested cases
 register_deserialization(is_alternative_prior, deserialize_alternative_prior)
-
-
-def warn_class_deprecation(func):
-    """Warn about the deprecation of this module."""
-
-    @functools.wraps(func)
-    def wrapper(self, *args, **kwargs):
-        name = self.__class__.__name__
-        warnings.warn(
-            f"The {name} class has moved to pymc_extras.prior module and will be removed in a future release. "
-            f"Import it from `from pymc_extras.prior import {name}`. ",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return func(self, *args, **kwargs)
-
-    return wrapper
-
-
-def warn_function_deprecation(func):
-    """Warn about the deprecation of this function."""
-
-    @functools.wraps(func)
-    def wrapper(*args, **kwargs):
-        name = func.__name__
-        warnings.warn(
-            f"The {name} function has moved to pymc_extras.prior module and will be removed in a future release. "
-            f"Import it from `from pymc_extras.prior import {name}`.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return func(*args, **kwargs)
-
-    return wrapper
-
-
-class Prior(prior.Prior):
-    """Backwards-compatible wrapper for the Prior class."""
-
-    @warn_class_deprecation
-    def __init__(self, *args, **kwargs):
-        """Initialize the Prior class with the given arguments."""
-        super().__init__(*args, **kwargs)
-
-
-class Censored(prior.Censored):
-    """Backwards-compatible wrapper for the CensoredPrior class."""
-
-    @warn_class_deprecation
-    def __init__(self, *args, **kwargs):
-        """Initialize the CensoredPrior class with the given arguments."""
-        super().__init__(*args, **kwargs)
-
-
-class Scaled(prior.Scaled):
-    """Backwards-compatible wrapper for the ScaledPrior class."""
-
-    @warn_class_deprecation
-    def __init__(self, *args, **kwargs):
-        """Initialize the ScaledPrior class with the given arguments."""
-        super().__init__(*args, **kwargs)
-
-
-sample_prior = warn_function_deprecation(prior.sample_prior)
-create_dim_handler = warn_function_deprecation(prior.create_dim_handler)
-handle_dims = warn_function_deprecation(prior.handle_dims)
-register_tensor_transform = warn_function_deprecation(prior.register_tensor_transform)

streamlit/mmm-explainer/pages/Fourier_Seasonality.py

@@ -14,10 +14,10 @@
 """Streamlit page for fourier modes."""
 
 import plotly.graph_objects as go
+from pymc_extras.prior import Prior
 
 import streamlit as st
 from pymc_marketing.mmm import MonthlyFourier, YearlyFourier
-from pymc_marketing.prior import Prior
 
 # Constants
 PLOT_HEIGHT = 500

tests/mmm/test_fourier.py

@@ -23,6 +23,7 @@
     deserialize,
     register_deserialization,
 )
+from pymc_extras.prior import Prior
 
 from pymc_marketing.mmm.fourier import (
     FourierBase,
@@ -31,7 +32,6 @@
     YearlyFourier,
     generate_fourier_modes,
 )
-from pymc_marketing.prior import Prior
 
 
 @pytest.mark.parametrize(

tests/test_prior.py

@@ -16,7 +16,9 @@
 from pymc_extras.deserialize import deserialize
 from pymc_extras.prior import Prior
 
-from pymc_marketing import prior
+from pymc_marketing import (
+    prior,  # noqa: F401 - import needed to register custom deserializers
+)
 
 
 @pytest.mark.parametrize(
@@ -51,17 +53,3 @@
 )
 def test_alternative_prior_deserialize(data, expected) -> None:
     assert deserialize(data) == expected
-
-
-@pytest.mark.parametrize(
-    "obj, args, kwargs, match",
-    [
-        (prior.Prior, ["Normal"], {}, "The Prior class"),
-        (prior.Censored, [Prior("Normal")], dict(lower=0), "The Censored"),
-        (prior.Scaled, [Prior("Normal")], dict(factor=2), "The Scaled"),
-        (prior.create_dim_handler, [("date", "channel")], {}, "The create_dim_handler"),
-    ],
-)
-def test_deprecation_warnings(obj, args, kwargs, match):
-    with pytest.warns(DeprecationWarning, match=match):
-        obj(*args, **kwargs)