Improvements

Brief Description

This is supposed to be the page that registers all of the (hopefully) good suggestions to the library.

List of Suggested Features

1. Add Docstring References to all relevant functions and methods.
   • Status: done for the beta_geo_fitter.py, pareto_nbd_fitter.py and plotting.py files.
2. Add Direct Mention to the Main Articles on the main README.md and the documentation.
   • Status: partially done and not yet included in any PR.
3. Validation of the Gamma-Gamma Model
   • Status: almost done.
   • Description: as suggested in Issue #288, it would be nice to be able to confirm (visually and numerically) that the Gamma-Gamma fit with the specified penalizer is good. One possible feature towards a solution is to plot the actual and the model's Gamma distribution of the average transaction value. This is cited in P. Fader and B. Hardie showed in their The Gamma-Gamma Model of Monetary Value paper (page 8, figure 3).
4. Systematic Report of how fit the RFM distributions are for the BG/NBD and Pareto/NBD models.
   • Status: not yet started.
5. Create a Dockerfile with a Conventioned setup for the library.
   • Status: almost done, but still a bit far from a PR.
   • Description: the Dockerfile will create a container where things will always work, eliminating installation issues and making everything reproducible anywhere. This will also help with contributions, as all contributors will end up with the same environment.
6. Add notes about the why we use repeat purchases and why we eliminate the first transactions in the code.
   • Status: not yet scheduled.
   • Description: More information about this topic can be found on the Vignettes section of the BTYD library, which is mentioned at the main page of the Lifetimes library.
7. Put the _negative_log_likelihood() result inside the fitter's summary and make the convergence another plot.
   • Status: waiting for PR approval.
8. Add a better description to the Calibration vs Holdout Purchases Plot
   • Status: not yet scheduled.
9. Add more documentation to the expected_cumulative_transactions() function.
   • Status: waiting for PR approval.
10. Look into column naming inconsistencies in the BetaGeoBetaBinomFitter and also create a summary property for the ParetoNBDFitter.
    • Status: not yet scheduled.