rename product_incrementality module to cc

pymc-labs · Oct 25, 2024 · c865183 · c865183
1 parent 7e90da2
commit c865183
Show file tree

Hide file tree

Showing 19 changed files with 531 additions and 1,150 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -172,6 +172,16 @@ Classes
 
 ![](docs/source/uml/classes_clv.png)
 
+## Overview of the CC codebase
+
+Packages
+
+![](docs/source/uml/packages_cc.png)
+
+Classes
+
+![](docs/source/uml/classes_cc.png)
+
 ---
 
 This guide takes some inspiration from the [Bambi guide to contributing](https://github.com/bambinos/bambi/blob/main/CONTRIBUTING.md)
diff --git a/Makefile b/Makefile
@@ -49,6 +49,7 @@ uml: ## Install documentation dependencies and generate UML diagrams
 	pip install .[docs]
 	pyreverse pymc_marketing/mmm -d docs/source/uml -f 'ALL' -o png -p mmm
 	pyreverse pymc_marketing/clv -d docs/source/uml -f 'ALL' -o png -p clv
+	pyreverse pymc_marketing/cc -d docs/source/uml -f 'ALL' -o png -p cc
 
 mlflow_server: ## Start MLflow server on port 5000
 	mlflow server --backend-store-uri sqlite:///mlruns.db --default-artifact-root ./mlruns

diff --git a/docs/source/api/index.md b/docs/source/api/index.md
@@ -13,7 +13,7 @@
   model_config
   model_builder
   prior
-  product_incrementality
+  cc
   metrics
   mlflow
 ```
diff --git a/docs/source/guide/index.md b/docs/source/guide/index.md
@@ -33,6 +33,6 @@ clv/clv_intro
 :caption: Product incrementality
 :maxdepth: 1
 
-product_incrementality/incrementality_intro
-product_incrementality/mv_its_intro
+cc/incrementality_intro
+cc/mv_its_intro
 :::
diff --git a/...uct_incrementality/mv_its_saturated.ipynb → ...ource/notebooks/cc/mv_its_saturated.ipynb b/...uct_incrementality/mv_its_saturated.ipynb → ...ource/notebooks/cc/mv_its_saturated.ipynb