`GammaGammaModel` Docstrings and API Standardization #758

ColtAllen · 2024-06-19T00:16:54Z

Description

This is the final PR to standardize the CLV API prior to the new release. It also speeds up the customer_lifetime_value function quite a bit because it gets rid of a FOR loop initialization that raises a DIV/0 warning.

Right now it's still a draft so that I can review the docs prebuild to make any necessary edits to the docstrings. The Quickstart and Gamma-Gamma notebooks will also require revision.

It's worth noting there's an additional Gamma-Gamma model for individual customers that isn't referenced in any of the notebooks.

Related Issue

Closes #CLV API Standardization #527, Remove future_t=0 predictions from expected_customer_lifetime_value function #596

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)
If you are a pro: each commit corresponds to a relevant logical change

Modules affected

MMM
CLV

Type of change

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

…arketing into gamma_gamma_api

codecov · 2024-06-19T00:38:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.89%. Comparing base (0bfca1a) to head (e116420).

❗ Current head e116420 differs from pull request most recent head 05cfd5e

Please upload reports for the commit 05cfd5e to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #758      +/-   ##
==========================================
+ Coverage   93.87%   93.89%   +0.01%     
==========================================
  Files          28       28              
  Lines        2972     2948      -24     
==========================================
- Hits         2790     2768      -22     
+ Misses        182      180       -2

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

pymc_marketing/clv/utils.py

juanitorduz

Lookin good!! Just left some small comments. Just ping me again when you are ready for a final review.

pymc_marketing/clv/models/gamma_gamma.py

tests/clv/test_utils.py

pymc_marketing/clv/models/gamma_gamma.py

pymc_marketing/clv/utils.py

…arketing into gamma_gamma_api

juanitorduz · 2024-06-25T18:20:32Z

He y @ColtAllen is this one ready fro a final review or merge?

review-notebook-app · 2024-06-25T22:48:08Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

ColtAllen · 2024-06-25T23:32:19Z

He y @ColtAllen is this one ready fro a final review or merge?

It's ready for review now, but there's a merge conflict in the Quickstart notebook and I'm unable to resolve it.

This reverts commit a3154d9.

juanitorduz · 2024-06-26T07:52:42Z

It's ready for review now, but there's a merge conflict in the Quickstart notebook and I'm unable to resolve it.

Ups! Notebooks are a pain! I suggest removing it from the PR, rebase and commit it again (or open another PR with the notebook later)

https://stackoverflow.com/questions/38743912/remove-a-file-from-a-git-pull-request

juanitorduz · 2024-06-26T07:53:40Z

Can you please push an empty commit to trigger the CI again? (I seems its stuck)

ColtAllen · 2024-06-26T12:42:51Z

I've reverted the CLV Quickstart changes. I'll do one more quick PR for this (and any other discrepancies in the docs) before the next release.

juanitorduz

LGTM!

Before you merge, could you please fix the two small doc issues below? Thanks :D

pymc_marketing/clv/models/gamma_gamma.py

juanitorduz · 2024-06-27T07:44:06Z

@ColtAllen is this one ready to be merged 🟢 ?

juanitorduz · 2024-06-27T07:46:26Z

Aslo, do you think this is enough for 0.7.0 (in view of #527 ?)

ColtAllen · 2024-06-27T08:04:26Z

Aslo, do you think this is enough for 0.7.0 (in view of #527 ?)

Yes; the remaining tasks in that issue are BetaGeoModel specific and extraneous to API standardization, so I'll close that issue and create a new one for the BG/NBD tasks.

I'll get started on the PR today for the CLV Quickstart and docstring proof-reading.

* utils.customer_lifetime_value * expected_customer_lifetime_value * WIP clv.models.gamma_gamma.py * gamma_gamma API * fixed circular import * gamma_gamma tests * delete tests/datasets/test_summary.csv * clv test_utils.py * remove expected_purchases(future_t=0) * remove monetary_value arg * WIP docstrings * notebooks * docstrings * Revert "notebooks" This reverts commit a3154d9. * gamma-gamma notebook * docstrings

ColtAllen added 9 commits June 14, 2024 13:08

utils.customer_lifetime_value

ef5d702

expected_customer_lifetime_value

b875b88

WIP clv.models.gamma_gamma.py

d598c93

gamma_gamma API

f4dd0ce

fixed circular import

d0293fa

gamma_gamma tests

25d709e

delete tests/datasets/test_summary.csv

9332039

clv test_utils.py

1accc34

remove expected_purchases(future_t=0)

9b0b4bf

ColtAllen added docs Improvements or additions to documentation invalid This doesn't seem right CLV maintenance tests priority: high major API breaking changes labels Jun 19, 2024

ColtAllen added this to the 0.7.0 milestone Jun 19, 2024

ColtAllen requested review from juanitorduz and wd60622 June 19, 2024 00:16

ColtAllen self-assigned this Jun 19, 2024

ColtAllen mentioned this pull request Jun 19, 2024

CLV API Standardization #527

Open

6 tasks

ColtAllen changed the title ~~GammaGammaModel API~~ GammaGammaModel API Improvements Jun 19, 2024

ColtAllen and others added 2 commits June 18, 2024 18:20

Merge branch 'main' into gamma_gamma_api

b957c3b

Merge branch 'gamma_gamma_api' of https://github.com/ColtAllen/pymc-m…

7cf7f3f

…arketing into gamma_gamma_api

wd60622 reviewed Jun 19, 2024

View reviewed changes

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

juanitorduz reviewed Jun 19, 2024

View reviewed changes

wd60622 reviewed Jun 22, 2024

View reviewed changes

pymc_marketing/clv/models/gamma_gamma.py Outdated Show resolved Hide resolved

pymc_marketing/clv/models/gamma_gamma.py Outdated Show resolved Hide resolved

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

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

ColtAllen and others added 2 commits June 22, 2024 11:39

remove monetary_value arg

ea2ded2

Merge branch 'pymc-labs:main' into gamma_gamma_api

7920a99

ColtAllen added 2 commits June 22, 2024 11:40

Merge branch 'gamma_gamma_api' of https://github.com/ColtAllen/pymc-m…

6505127

…arketing into gamma_gamma_api

WIP docstrings

e116420

notebooks

a3154d9

docstrings

89dc5ab

ColtAllen marked this pull request as ready for review June 25, 2024 23:31

Revert "notebooks"

6886aa1

This reverts commit a3154d9.

ColtAllen and others added 2 commits June 26, 2024 13:37

gamma-gamma notebook

ef1bb07

Merge branch 'main' into gamma_gamma_api

7b45241

juanitorduz approved these changes Jun 26, 2024

View reviewed changes

pymc_marketing/clv/models/gamma_gamma.py Outdated Show resolved Hide resolved

pymc_marketing/clv/models/gamma_gamma.py Show resolved Hide resolved

docstrings

05cfd5e

ColtAllen merged commit cec2cc2 into pymc-labs:main Jun 27, 2024
10 checks passed

ColtAllen deleted the gamma_gamma_api branch June 27, 2024 08:02

ColtAllen changed the title ~~GammaGammaModel API Improvements~~ GammaGammaModel Docstrings and API Standardization Jun 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`GammaGammaModel` Docstrings and API Standardization #758

`GammaGammaModel` Docstrings and API Standardization #758

ColtAllen commented Jun 19, 2024 •

edited by github-actions bot

Loading

codecov bot commented Jun 19, 2024 •

edited

Loading

juanitorduz left a comment

juanitorduz commented Jun 25, 2024

review-notebook-app bot commented Jun 25, 2024

ColtAllen commented Jun 25, 2024

juanitorduz commented Jun 26, 2024

juanitorduz commented Jun 26, 2024

ColtAllen commented Jun 26, 2024

juanitorduz left a comment

juanitorduz commented Jun 27, 2024

juanitorduz commented Jun 27, 2024

ColtAllen commented Jun 27, 2024

GammaGammaModel Docstrings and API Standardization #758

GammaGammaModel Docstrings and API Standardization #758

Conversation

ColtAllen commented Jun 19, 2024 • edited by github-actions bot Loading

Description

Related Issue

Checklist

Modules affected

Type of change

codecov bot commented Jun 19, 2024 • edited Loading

Codecov Report

juanitorduz left a comment

Choose a reason for hiding this comment

juanitorduz commented Jun 25, 2024

review-notebook-app bot commented Jun 25, 2024

ColtAllen commented Jun 25, 2024

juanitorduz commented Jun 26, 2024

juanitorduz commented Jun 26, 2024

ColtAllen commented Jun 26, 2024

juanitorduz left a comment

Choose a reason for hiding this comment

juanitorduz commented Jun 27, 2024

juanitorduz commented Jun 27, 2024

ColtAllen commented Jun 27, 2024

`GammaGammaModel` Docstrings and API Standardization #758

`GammaGammaModel` Docstrings and API Standardization #758

ColtAllen commented Jun 19, 2024 •

edited by github-actions bot

Loading

codecov bot commented Jun 19, 2024 •

edited

Loading