FancierLinearRegression

[williambdean]

Description

Migration ... but also open to removal...

Related Issue

• Closes #
• Related to multidimensional.MMM y needs Series name #2314

Checklist

• Checked that the pre-commit linting/style checks pass. Feel free to comment pre-commit.ci autofix to auto-fix.
• Included tests that prove the fix is effective or that the new feature works
• Added necessary documentation (docstrings and/or example notebooks) using numpydoc format.
• If you are a pro: each commit corresponds to a relevant logical change

[cursor]

PR Summary

Low Risk
Small migration and test update; main risk is downstream code relying on the previous fit-result variable names/import path.

Overview
FancyLinearRegression is updated to construct and document against pymc_marketing.mmm.multidimensional.MMM instead of the legacy mmm.MMM.

The associated test is adjusted for the new model outputs: the target series is explicitly named, and assertions are updated to the new InferenceData variable set (notably switching from intercept to intercept_contribution and from total_contribution to total_media_contribution_original_scale, and dropping several legacy *_original_scale contribution variables).

^{Written by Cursor Bugbot for commit b9262bb. This will update automatically on new commits. Configure here.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.05%. Comparing base (e5f50ea) to head (b9262bb).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2315   +/-   ##
=======================================
  Coverage   93.05%   93.05%           
=======================================
  Files          78       78           
  Lines       12230    12230           
=======================================
  Hits        11381    11381           
  Misses        849      849           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ricardoV94]

What's the argument for keeping/removing?

If nobody uses it, sure

[ricardoV94]

Trying to fix CI in #2316

[juanitorduz]

I think we should promote these baselines more. So I would not remove it.

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

[cursor]

Return type incompatible with publicly exported MMM class

High Severity

FancyLinearRegression now returns an instance of pymc_marketing.mmm.multidimensional.MMM, but the public API in pymc_marketing/mmm/__init__.py still exports MMM from pymc_marketing.mmm.mmm — a completely unrelated class with no shared inheritance. Users who from pymc_marketing.mmm import MMM, FancyLinearRegression will find that isinstance(FancyLinearRegression(...), MMM) returns False. The test masks this by importing MMM directly from multidimensional rather than using the public API.

Additional Locations (1)

• tests/mmm/test_linear_regression.py#L18-L19

 

[juanitorduz]

I think is ok, as we will work on the migration soon. Wdyt @williambdean ?

[williambdean]

yeah, that's fine.