Rename `clv_summary` to `rfm_summary` and extend functionality #479

ColtAllen · 2024-01-08T00:27:04Z

Description

This PR adds some enhancements to the existing clv_summary function and renames it to rfm_summary, which is a better descriptor for what this function does. Specific changes are described in #469.

The RFM Analysis interpretation of recency was not added in this PR. Instead of creating an additional column unnecessary for predictive modeling, it would make more sense to create that column (which is simply T-recency within a future model for Bayesian RFM segmentation.

Related Issue

Closes # clv_summary Enhancements #469
Closes Wrong monetary value #466

Checklist

Checked that the pre-commit linting/style checks pass
Included tests that prove the fix is effective or that the new feature works
Added necessary documentation (docstrings and/or example notebooks)
(https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes)

Modules affected

MMM
CLV

Type of change

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

codecov · 2024-01-08T00:46:03Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (49e1e80) 90.83% compared to head (d416a08) 90.87%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #479      +/-   ##
==========================================
+ Coverage   90.83%   90.87%   +0.04%     
==========================================
  Files          21       21              
  Lines        1974     1983       +9     
==========================================
+ Hits         1793     1802       +9     
  Misses        181      181

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

ricardoV94

Small suggestion to simplify the docstring.

Should we keep clv_summary with a deprecation warning so we don't break people's code? Something like:

https://github.com/pymc-devs/pytensor/blob/c5b96d925d2005fe5f7be3883f7022f05cd29cc3/pytensor/graph/replace.py#L325-L327

Also is this not used in any of our public notebooks? Those would need to be updated.

pymc_marketing/clv/utils.py

review-notebook-app · 2024-01-08T22:10:13Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

ColtAllen · 2024-01-08T22:11:57Z

Should we keep clv_summary with a deprecation warning so we don't break people's code?

Also is this not used in any of our public notebooks? Those would need to be updated.

Done and done 👍

Using a different dataset required updating all the charts and results in the notebook. I also used the opportunity to fix #466.

review-notebook-app · 2024-01-11T14:48:37Z

View / edit / reply to this conversation on ReviewNB

ricardoV94 commented on 2024-01-11T14:48:36Z
----------------------------------------------------------------

We should put and read the dataset from here: https://github.com/pymc-labs/pymc-marketing/tree/main/datasets

ColtAllen commented on 2024-01-11T15:44:42Z
----------------------------------------------------------------

If rfm_summary is to be included in this Quickstart (and I think it should because it's an important data preprocessing step) then we can't use that dataset. The purpose of this function is to format raw transactions for modeling, and that dataset is already formatted.

ricardoV94 commented on 2024-01-11T15:48:44Z
----------------------------------------------------------------

Just replace the one that's there with the unformatted one? The dataset is there just for the purpose of being used in examples.

review-notebook-app · 2024-01-11T14:48:38Z

View / edit / reply to this conversation on ReviewNB

ricardoV94 commented on 2024-01-11T14:48:37Z
----------------------------------------------------------------

There may be an error in the rfm function. The estimates of a and alpha are rather different than what we had before

ColtAllen commented on 2024-01-11T15:45:51Z
----------------------------------------------------------------

No error - just a different dataset (or rather, a different subset of CDNOW_MASTER.txt, which is rather large for testing).

ricardoV94 commented on 2024-01-11T15:49:13Z
----------------------------------------------------------------

Okay. Is this subset fixed or does it change when the NB is rerun?

ricardoV94 commented on 2024-01-11T15:50:59Z
----------------------------------------------------------------

I see you have a random_seed, perfect!

review-notebook-app · 2024-01-11T14:48:39Z

View / edit / reply to this conversation on ReviewNB

ricardoV94 commented on 2024-01-11T14:48:38Z
----------------------------------------------------------------

Here we can also see large differences compared to before

ColtAllen commented on 2024-01-11T15:45:59Z
----------------------------------------------------------------

See above

review-notebook-app · 2024-01-11T14:48:40Z

View / edit / reply to this conversation on ReviewNB

ricardoV94 commented on 2024-01-11T14:48:39Z
----------------------------------------------------------------

Line break in representin/ng

ColtAllen commented on 2024-01-11T15:51:09Z
----------------------------------------------------------------

This linebreak does not appear in Jupyter, PyCharm, or even the docs build preview. I'm not sure why ReviewNB isn't displaying properly here.

ricardoV94 commented on 2024-01-11T15:52:38Z
----------------------------------------------------------------

Must be a glitch then. The docs preview should be enough

review-notebook-app · 2024-01-11T14:48:41Z

View / edit / reply to this conversation on ReviewNB

ricardoV94 commented on 2024-01-11T14:48:40Z
----------------------------------------------------------------

Estimates also changed considerably in this model

ColtAllen commented on 2024-01-11T15:46:45Z
----------------------------------------------------------------

Different dataset; see above.

ricardoV94 · 2024-01-11T14:51:08Z

@ColtAllen I seem some large differences in the NB results. I suspect there may be a bug in the new function, or in what the model is expecting

ColtAllen · 2024-01-11T15:44:44Z

If rfm_summary is to be included in this Quickstart (and I think it should because it's an important data preprocessing step) then we can't use that dataset. The purpose of this function is to format raw transactions for modeling, and that dataset is already formatted.

View entire conversation on ReviewNB

ColtAllen · 2024-01-11T15:45:53Z

No error - just a different dataset (or rather, a different subset of CDNOW_MASTER.txt, which is rather large for testing).

View entire conversation on ReviewNB

ColtAllen · 2024-01-11T15:46:00Z

See above

View entire conversation on ReviewNB

ColtAllen · 2024-01-11T15:46:47Z

Different dataset; see above.

View entire conversation on ReviewNB

ricardoV94 · 2024-01-11T15:48:45Z

Just replace the one that's there with the unformatted one? The dataset is there just for the purpose of being used in examples.

View entire conversation on ReviewNB

ricardoV94 · 2024-01-11T15:49:14Z

Okay. Is this subset fixed or does it change when the NB is rerun?

View entire conversation on ReviewNB

ricardoV94 · 2024-01-11T15:51:00Z

I see you have a random_seed, perfect!

View entire conversation on ReviewNB

ColtAllen · 2024-01-11T15:51:11Z

This linebreak does not appear in Jupyter, PyCharm, or even the docs build preview. I'm not sure why ReviewNB isn't displaying properly here.

View entire conversation on ReviewNB

ricardoV94 · 2024-01-11T15:52:39Z

Must be a glitch then. The docs preview should be enough

View entire conversation on ReviewNB

ricardoV94 · 2024-01-11T15:54:08Z

Pre-commit is also complaining. Otherwise besides adding the dataset to a more user-facing location, everything looks on spot!

ColtAllen · 2024-01-11T16:11:37Z

Dataset has been moved to https://github.com/pymc-labs/pymc-marketing/tree/main/datasets

ColtAllen · 2024-01-11T16:17:33Z

Pre-commit

Did isort auto-correct the order of imports? ruff-format only seems to be working properly in the Git CI. I'm not getting any corrections or exceptions raised prior to pushing to the repo.

ricardoV94 · 2024-01-11T17:06:34Z

Did isort auto-correct the order of imports? ruff-format only seems to be working properly in the Git CI. I'm not getting any corrections or exceptions raised prior to pushing to the repo.

No idea, but all looks green now!

ricardoV94 · 2024-01-11T17:07:05Z

Did you change the import in the NB?

ColtAllen · 2024-01-12T15:45:23Z

Did you change the import in the NB?

It's fixed now.

* current status as method * format * Update version.txt * Implement different convolution modes (#454) * Add PR template * Update pull_request_template.md * Fix issues in index example * Update .pre-commit-config.yaml * Update .pre-commit-config.yaml * move from other PR * put legend on side * Optimisation in customer_lifetime_value when discount_rate == 0 (#468) * Optimisation in customer_lifetime_value when discount_rate == 0 cf #467 * Update utils.py * Update README.md * add support for pre-commit-ci * add isort * modify autosummary templates * Rename `clv_summary` to `rfm_summary` and extend functionality (#479) * clv_summary adapted into rfm_summary * added clv_summary with warning * moved dataset from testing folder * Update version.txt * improve ruff * [pre-commit.ci] pre-commit autoupdate updates: - [github.com/astral-sh/ruff-pre-commit: v0.1.11 → v0.1.14](astral-sh/ruff-pre-commit@v0.1.11...v0.1.14) - [github.com/pre-commit/pre-commit-hooks: v3.2.0 → v4.5.0](pre-commit/pre-commit-hooks@v3.2.0...v4.5.0) * resolve conflict * Add baselined saturation (#498) * add baselined saturation with test and plots * refactor docs * add the reparam * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * verify parametrization is equivalent under change of baseline * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add a note for setting x0 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * make it clear how r_ref is calculated * fix typo * fix docstrings * improve test by making sure transform is gives identical saturation and cac0 * add comment in the docstring * add blank line in the code-block --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Swap Before and After convolution modes as per #489 (#501) * Add support for string mode args * Swap before and after and make mode explicit * Use Union due Python 3.9 * Style * resolve conflict * add dim_name arg * add seed to tests and test methods * add slice as type hint * use slice in docstring * defaults to mean for each channel * add non-negative check * ax as last arg * change weeks -> time * parameterize quantiles * separate out and add to docs * rerun the baseline images * mock the prior * add new images from latest env * migrate to toml instead of ci/cd * test only is axes * remove the images --------- Co-authored-by: Juan Orduz <juan.orduz@wolt.com> Co-authored-by: Abdalaziz Rashid <abdalaziz.rashid@outlook.com> Co-authored-by: Ricardo Vieira <ricardo.vieira1994@gmail.com> Co-authored-by: Ricardo Vieira <28983449+ricardoV94@users.noreply.github.com> Co-authored-by: vincent-grosbois <vincent.grosbois@gmail.com> Co-authored-by: juanitorduz <juanitorduz@gmail.com> Co-authored-by: Oriol (ProDesk) <oriol.abril.pla@gmail.com> Co-authored-by: Colt Allen <10178857+ColtAllen@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Maxim Kochurov <max.kochurov@pymc-labs.com>

clv_summary adapted into rfm_summary

eb53627

ColtAllen added enhancement New feature or request CLV maintenance priority: high labels Jan 8, 2024

ColtAllen requested a review from ricardoV94 January 8, 2024 00:27

ColtAllen self-assigned this Jan 8, 2024

ricardoV94 changed the title ~~rfm_summary Utility Function~~ Rename clv_summary to rfm_summary and extend functionality Jan 8, 2024

ricardoV94 reviewed Jan 8, 2024

View reviewed changes

pymc_marketing/clv/utils.py Outdated Show resolved Hide resolved

ricardoV94 added major API breaking changes and removed priority: high labels Jan 8, 2024

ColtAllen added 2 commits January 8, 2024 13:38

added clv_summary with warning

bab7718

Notebook edits

115b64c

ColtAllen added 3 commits January 10, 2024 14:14

docstrings

a2f88d6

fixed typo

584410b

linting fix

689227c

ricardoV94 added docs Improvements or additions to documentation and removed major API breaking changes labels Jan 11, 2024

ColtAllen and others added 2 commits January 11, 2024 09:03

Merge branch 'pymc-labs:main' into rfm_summary

79a6ed1

moved dataset from testing folder

7157bd0

import order formatting

b165be2

updated dataset link in Quickstart

d416a08

ricardoV94 approved these changes Jan 15, 2024

View reviewed changes

ricardoV94 merged commit 103878d into pymc-labs:main Jan 15, 2024
12 checks passed

ColtAllen deleted the rfm_summary branch February 9, 2024 16:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename `clv_summary` to `rfm_summary` and extend functionality #479

Rename `clv_summary` to `rfm_summary` and extend functionality #479

ColtAllen commented Jan 8, 2024 •

edited by ricardoV94

Loading

codecov bot commented Jan 8, 2024 •

edited

Loading

ricardoV94 left a comment •

edited

Loading

review-notebook-app bot commented Jan 8, 2024

ColtAllen commented Jan 8, 2024

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

ricardoV94 commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024 •

edited

Loading

ColtAllen commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ColtAllen commented Jan 12, 2024

Rename clv_summary to rfm_summary and extend functionality #479

Rename clv_summary to rfm_summary and extend functionality #479

Conversation

ColtAllen commented Jan 8, 2024 • edited by ricardoV94 Loading

Description

Related Issue

Checklist

Modules affected

Type of change

codecov bot commented Jan 8, 2024 • edited Loading

Codecov Report

ricardoV94 left a comment • edited Loading

Choose a reason for hiding this comment

review-notebook-app bot commented Jan 8, 2024

ColtAllen commented Jan 8, 2024

review-notebook-app bot commented Jan 11, 2024 • edited Loading

review-notebook-app bot commented Jan 11, 2024 • edited Loading

review-notebook-app bot commented Jan 11, 2024 • edited Loading

review-notebook-app bot commented Jan 11, 2024 • edited Loading

review-notebook-app bot commented Jan 11, 2024 • edited Loading

ricardoV94 commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024 • edited Loading

ColtAllen commented Jan 11, 2024

ColtAllen commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ricardoV94 commented Jan 11, 2024

ColtAllen commented Jan 12, 2024

Rename `clv_summary` to `rfm_summary` and extend functionality #479

Rename `clv_summary` to `rfm_summary` and extend functionality #479

ColtAllen commented Jan 8, 2024 •

edited by ricardoV94

Loading

codecov bot commented Jan 8, 2024 •

edited

Loading

ricardoV94 left a comment •

edited

Loading

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

review-notebook-app bot commented Jan 11, 2024 •

edited

Loading

ricardoV94 commented Jan 11, 2024 •

edited

Loading