Add basis bumps effect to MMM model

[wd60622]

Description

The API

mmm = MMM(...)

mmm.add_events(df_holidays, prefix="holiday", effect=...)
mmm.add_events(df_weekends, prefix="weekend", effect=...)
mmm.add_events(df_earning_calls, prefix="earning_call", effect=...)
mmm.build_model(X, y)

TODO:

• Handle out of sample predictions
• Relax the EventEffect requiring dims / make assumptions since it will be duplicated in the effect

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

[codecov]

Codecov Report

Attention: Patch coverage is 96.38554% with 3 lines in your changes missing coverage. Please review.

Project coverage is 92.59%. Comparing base (eec024d) to head (046bc5d).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
pymc_marketing/mmm/multidimensional.py	96.22%	2 Missing ⚠️
pymc_marketing/mmm/events.py	96.29%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1475      +/-   ##
==========================================
+ Coverage   92.55%   92.59%   +0.04%     
==========================================
  Files          52       52              
  Lines        5947     6026      +79     
==========================================
+ Hits         5504     5580      +76     
- Misses        443      446       +3     

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

[wd60622]

Do we want control over this? @juanitorduz

[juanitorduz]

seems reasonable

[wd60622]

Reasonable default or would it be passed with Basis? It causes issue if we are trying to keep track of what the user passes though for building the model

[juanitorduz]

I do not have a strong opinion so I suggest whatever you feel is easiest to maintain. We can release and collect feedback.

[juanitorduz]

Looks very nice! I left som minor comments.

Are the open to-dos meant to be included in this PR?

[juanitorduz]

seems reasonable

[wd60622]

Addressed the feedback. I will make the todos into new issues

[wd60622]

Working on the out of sample now

[wd60622]

This should be good to go now. I will work toward the storing off of the events in another PR (#1484)

[juanitorduz]

This is very cool! I'll try to see if I can add this to the mmm example notebook as well have two events.