diff --git a/docs/source/notebooks/clv/bg_nbd.ipynb b/docs/source/notebooks/clv/bg_nbd.ipynb
index 949071f66..5456b3453 100644
--- a/docs/source/notebooks/clv/bg_nbd.ipynb
+++ b/docs/source/notebooks/clv/bg_nbd.ipynb
@@ -5,56 +5,59 @@
"id": "51e3591e",
"metadata": {},
"source": [
- "# BG/NBD model\n",
+ "# BG/NBD Model\n",
"\n",
- "Comparison with lifetimes"
+ "In this notebook we show how to fit a BG/NBD model in PyMC-Marketing. We compare the results with the [`lifetimes`](https://github.com/CamDavidsonPilon/lifetimes) package (no longer maintained). The model is presented in the paper: Fader, P. S., Hardie, B. G., & Lee, K. L. (2005). [“Counting your customers” the easy way: An alternative to the Pareto/NBD model. Marketing science, 24(2), 275-284.](http://www.brucehardie.com/papers/bgnbd_2004-04-20.pdf)"
]
},
{
"cell_type": "markdown",
- "id": "80697def",
+ "id": "68f7ba7e",
"metadata": {},
"source": [
- "**Reference**: Fader, P. S., Hardie, B. G., & Lee, K. L. (2005). “Counting your customers” the easy way: An alternative to the Pareto/NBD model. Marketing science, 24(2), 275-284.\n",
- "\n",
- "http://www.brucehardie.com/papers/bgnbd_2004-04-20.pdf"
+ "## Prepare Notebook"
]
},
{
"cell_type": "code",
- "execution_count": 1,
+ "execution_count": null,
"id": "81c950fb",
"metadata": {},
"outputs": [],
"source": [
- "import numpy as np\n",
+ "import arviz as az\n",
+ "import matplotlib.pyplot as plt\n",
"import pandas as pd\n",
- "from lifetimes import BetaGeoFitter"
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 2,
- "id": "8ee1b882",
- "metadata": {},
- "outputs": [],
- "source": [
- "from lifetimes.datasets import load_cdnow_summary"
+ "import xarray as xr\n",
+ "from fastprogress.fastprogress import progress_bar\n",
+ "from lifetimes import BetaGeoFitter\n",
+ "\n",
+ "from pymc_marketing import clv\n",
+ "\n",
+ "# Plotting configuration\n",
+ "az.style.use(\"arviz-darkgrid\")\n",
+ "plt.rcParams[\"figure.figsize\"] = [12, 7]\n",
+ "plt.rcParams[\"figure.dpi\"] = 100\n",
+ "plt.rcParams[\"figure.facecolor\"] = \"white\"\n",
+ "\n",
+ "%load_ext autoreload\n",
+ "%autoreload 2\n",
+ "%config InlineBackend.figure_format = \"retina\""
]
},
{
- "cell_type": "code",
- "execution_count": 3,
- "id": "4a2dfdcd",
+ "cell_type": "markdown",
+ "id": "6e4b3b25",
"metadata": {},
- "outputs": [],
"source": [
- "from pymc_marketing import clv"
+ "## Read Data\n",
+ "\n",
+ "We use the `CDNOW` dataset (see lifetimes [quick-start](https://lifetimes.readthedocs.io/en/latest/Quickstart.html))."
]
},
{
"cell_type": "code",
- "execution_count": 4,
+ "execution_count": 2,
"id": "a99638b5",
"metadata": {},
"outputs": [
@@ -82,153 +85,232 @@
"
frequency
\n",
"
recency
\n",
"
T
\n",
- " \n",
- "
\n",
- "
ID
\n",
- "
\n",
- "
\n",
- "
\n",
+ "
monetary_value
\n",
"
\n",
" \n",
" \n",
"
\n",
- "
1
\n",
+ "
0
\n",
"
2
\n",
"
30.43
\n",
"
38.86
\n",
+ "
22.35
\n",
"
\n",
"
\n",
- "
2
\n",
+ "
1
\n",
"
1
\n",
"
1.71
\n",
"
38.86
\n",
+ "
11.77
\n",
"
\n",
"
\n",
- "
3
\n",
+ "
2
\n",
"
0
\n",
"
0.00
\n",
"
38.86
\n",
+ "
0.00
\n",
"
\n",
"
\n",
- "
4
\n",
+ "
3
\n",
"
0
\n",
"
0.00
\n",
"
38.86
\n",
+ "
0.00
\n",
"
\n",
"
\n",
- "
5
\n",
+ "
4
\n",
"
0
\n",
"
0.00
\n",
"
38.86
\n",
+ "
0.00
\n",
"
\n",
" \n",
"\n",
""
],
"text/plain": [
- " frequency recency T\n",
- "ID \n",
- "1 2 30.43 38.86\n",
- "2 1 1.71 38.86\n",
- "3 0 0.00 38.86\n",
- "4 0 0.00 38.86\n",
- "5 0 0.00 38.86"
+ " frequency recency T monetary_value\n",
+ "0 2 30.43 38.86 22.35\n",
+ "1 1 1.71 38.86 11.77\n",
+ "2 0 0.00 38.86 0.00\n",
+ "3 0 0.00 38.86 0.00\n",
+ "4 0 0.00 38.86 0.00"
]
},
- "execution_count": 4,
+ "execution_count": 2,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
- "df = load_cdnow_summary(index_col=[0])\n",
+ "data_path = \"https://raw.githubusercontent.com/pymc-labs/pymc-marketing/main/datasets/clv_quickstart.csv\"\n",
+ "\n",
+ "df = pd.read_csv(data_path)\n",
+ "\n",
"df.head()"
]
},
+ {
+ "cell_type": "markdown",
+ "id": "35cc830b",
+ "metadata": {},
+ "source": [
+ "Recall from the `lifetimes` documentation the following definitions:\n",
+ "\n",
+ "> - `frequency` represents the number of repeat purchases the customer has made. This means that it’s one less than the total number of purchases. This is actually slightly wrong. It’s the count of time periods the customer had a purchase in. So if using days as units, then it’s the count of days the customer had a purchase on.\n",
+ "> - `T` represents the age of the customer in whatever time units chosen (weekly, in the above dataset). This is equal to the duration between a customer’s first purchase and the end of the period under study.\n",
+ "> - `recency` represents the age of the customer when they made their most recent purchases. This is equal to the duration between a customer’s first purchase and their latest purchase. (Thus if they have made only 1 purchase, the recency is 0.)"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "192738eb",
+ "metadata": {},
+ "source": [
+ "```{tip}\n",
+ "We rename the index column to `customer_id` as this is required by the model\n",
+ "```"
+ ]
+ },
{
"cell_type": "code",
- "execution_count": 5,
+ "execution_count": 3,
"id": "6eb810b4",
"metadata": {},
"outputs": [],
"source": [
- "data = pd.DataFrame({\n",
- " 'customer_id': np.arange(len(df['frequency'].values)),\n",
- " 'frequency': df[\"frequency\"].values,\n",
- " 'recency': df[\"recency\"].values,\n",
- " 'T': df['T'].values,\n",
- "})"
+ "data = (\n",
+ " df.reset_index()\n",
+ " .rename(columns={\"index\": \"customer_id\"})\n",
+ " .drop(columns=\"monetary_value\")\n",
+ ")"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "91cb4b6f",
+ "metadata": {},
+ "source": [
+ "## Model Specification\n",
+ "\n",
+ "The BG/NBD model is a probabilistic model that describes the buying behavior of a customer in the non-contractual setting. It is based on the following assumptions for each customer:\n",
+ "\n",
+ "### Frequency Process\n",
+ "\n",
+ "1. While active, the time between transactions is distributed exponential with transaction rate, i.e., \n",
+ "\n",
+ " $$f(t_{j}|t_{j-1}; \\lambda) = \\lambda \\exp(-\\lambda (t_{j} - t_{j - 1})), \\quad t_{j} \\geq t_{j - 1} \\geq 0$$ \n",
+ "\n",
+ "2. Heterogeneity in $\\lambda$ follows a gamma distribution with pdf\n",
+ "\n",
+ " $$f(\\lambda|r, \\alpha) = \\frac{\\alpha^{r}\\lambda^{r - 1}\\exp(-\\lambda \\alpha)}{\\Gamma(r)}, \\quad \\lambda > 0$$\n",
+ "\n",
+ "### Dropout Process\n",
+ "\n",
+ "3. After any transaction, a customer becomes inactive with probability $p$.\n",
+ "\n",
+ "4. Heterogeneity in $p$ follows a beta distribution with pdf\n",
+ "\n",
+ " $$f(p|a, b) = \\frac{\\Gamma(a + b)}{\\Gamma(a) \\Gamma(b)} p^{a - 1}(1 - p)^{b - 1}, \\quad 0 \\leq p \\leq 1$$\n",
+ "\n",
+ "5. The transaction rate $\\lambda$ and the dropout probability $p$ vary independently across customers.\n",
+ "\n",
+ "Instead of estimating $\\lambda$ and $p$ for each specific customer, we do it for a randomly chosen customer, i.e. we work with the expected values of the parameters. Hence, we are interesting in finding the posterior distribution of the parameters $r$, $\\alpha$, $a$, and $b$."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "6183c040",
+ "metadata": {},
+ "source": [
+ "## Model Fitting\n",
+ "\n",
+ "Estimating such parameters is very easy in PyMC-Marketing. We instantiate the model in a similar way:"
]
},
{
"cell_type": "code",
- "execution_count": 6,
+ "execution_count": 4,
"id": "13835b98",
"metadata": {},
+ "outputs": [],
+ "source": [
+ "model_mcmc = clv.BetaGeoModel(data=data)"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "efb17e6b",
+ "metadata": {},
+ "source": [
+ "We can *build* the model so that we can see the model specification:"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 5,
+ "id": "36acdf94",
+ "metadata": {},
"outputs": [
{
- "name": "stderr",
- "output_type": "stream",
- "text": [
- "Auto-assigning NUTS sampler...\n",
- "Initializing NUTS using jitter+adapt_diag...\n",
- "Multiprocess sampling (4 chains in 4 jobs)\n",
- "NUTS: [a, b, alpha, r]\n"
- ]
- },
- {
- "data": {
- "text/html": [
- "\n",
- "\n"
- ],
- "text/plain": [
- ""
- ]
- },
- "metadata": {},
- "output_type": "display_data"
- },
- {
- "data": {
- "text/html": [
- "\n",
- "