Preparing plots and notebook for old API deprecation

[cetagostini]

Description

Kick-off API deprecation. Made a new notebook, in dev not visible to replicate current MMM example but with multidimensional. Only a few plots are missing.

Did additions in the plot API, and adjust some docs.

Related Issue

• Closes #
• Related to #

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

---

📚 Documentation preview 📚: https://pymc-marketing--2055.org.readthedocs.build/en/2055/

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[codecov]

Codecov Report

❌ Patch coverage is 87.58389% with 37 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.33%. Comparing base (8fee905) to head (18b60f0).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
pymc_marketing/mmm/plot.py	85.53%	35 Missing ⚠️
pymc_marketing/mmm/utils.py	96.29%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2055      +/-   ##
==========================================
- Coverage   92.49%   92.33%   -0.16%     
==========================================
  Files          68       68              
  Lines        9364     9660     +296     
==========================================
+ Hits         8661     8920     +259     
- Misses        703      740      +37     

☔ 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.

[williambdean]

why so many changes in a single PR 😢

[williambdean]

First pass

[cetagostini-wise]

why so many changes in a single PR 😢

They are not many, purely docstring change you can ignore (I just move them to correct formatting).

The files with changes are:

• multidimensional.py
• plot.py
• utils.py

All under mmm folder :)

[Copilot]

Pull Request Overview

This pull request adds new plotting functionality and utility functions to the MMM module, updates docstring formatting across multiple files, and includes comprehensive test coverage for the new features.

• Adds build_contributions utility function for processing posterior contribution data into wide DataFrames
• Adds four new plotting methods: residuals_over_time, residuals_posterior_distribution, posterior_distribution, waterfall_components_decomposition, and channel_contribution_share_hdi
• Converts docstring examples from REPL-style (>>>) to code-block format for better rendering

Reviewed Changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
pymc_marketing/mmm/utils.py	Adds build_contributions function to aggregate and format contribution variables from posterior data
pymc_marketing/mmm/plot.py	Adds new plotting methods for residuals, posterior distributions, waterfall decomposition, and channel contribution shares
tests/mmm/test_utils.py	Adds comprehensive test suite for build_contributions function
tests/mmm/test_plot.py	Adds extensive test coverage for new plotting methods
pymc_marketing/mmm/multidimensional.py	Updates docstring formatting and fixes extend_idata logic in sample_posterior_predictive
pymc_marketing/model_builder.py	Converts docstring examples to code-block format
pymc_marketing/mmm/mmm.py	Converts docstring examples to code-block format
pymc_marketing/mmm/base.py	Converts docstring examples to code-block format
pymc_marketing/customer_choice/nested_logit.py	Converts docstring examples to code-block format
pymc_marketing/customer_choice/mnl_logit.py	Converts docstring examples to code-block format

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.