CLV API Deprecation

[ColtAllen]

Description

This PR brings the CLV API more in line with that of MMM by making the following change:

# old API
CLVModel(data).fit()

# new API
CLVModel().fit(data)

The old API will still be supported until v1.0. All notebooks have been updated with the new API.

This change is needed for improved model persistence (see related issue) which will be addressed in follow-up PRs.

Discussion Needed

Currently, covariates are parametrized as model config kwargs. For user convenience, is it also worth adding separate parameters for covariates? Would look like this:

covariates = {
    "purchase_cols": ["channel", "region"],
    "dropout_cols": ["tier"],
}

model = BetaGeoModel.with_covariates(
    purchase_cols=["channel", "region"],
    dropout_cols=["tier"],
    model_config=covariates, # old method (still supported)
)

Related Issue

• Related to Option to exclude fit data when saving models #1356

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--2347.org.readthedocs.build/en/2347/

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[cursor]

PR Summary

Low Risk
Low risk because changes are limited to editor/tooling guidance in .cursor/rules/basic.mdc and do not affect runtime code or behavior.

Overview
Adds a description field and expands .cursor/rules/basic.mdc with guidance to run pytest/pre-commit/python using the active environment’s absolute bin/ executable path (discovered via which/where) instead of relying on PATH.

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

[codecov]

Codecov Report

❌ Patch coverage is 92.85714% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.13%. Comparing base (877de08) to head (849e146).
⚠️ Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
pymc_marketing/clv/models/shifted_beta_geo.py	89.18%	4 Missing ⚠️
pymc_marketing/clv/models/gamma_gamma.py	88.88%	2 Missing ⚠️
pymc_marketing/clv/models/beta_geo_beta_binom.py	90.90%	1 Missing ⚠️
pymc_marketing/clv/models/modified_beta_geo.py	85.71%	1 Missing ⚠️
pymc_marketing/clv/models/pareto_nbd.py	95.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2347      +/-   ##
==========================================
- Coverage   93.15%   93.13%   -0.03%     
==========================================
  Files          79       79              
  Lines       12523    12610      +87     
==========================================
+ Hits        11666    11744      +78     
- Misses        857      866       +9     

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

[cursor]

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

[juanitorduz]

I think this PR is removing some .nc files

[ColtAllen]

I think this PR is removing some .nc files

Do the MMM notebooks require them? These files are quite large.

[juanitorduz]

Yes, for now we do. We might remove it later (but should be a different PR :) )

[ColtAllen]

We might remove it later (but should be a different PR :) )

Agreed; files restored.

[juanitorduz]

Thanks @ColtAllen I will check this one in the upcoming days 💪