Scale spend data to improve budget allocation efficacy

.github/workflows/ci.yml

@@ -7,62 +7,13 @@ on:
     branches: [main]
 
 env:
-  OLDEST_PYMC_VERSION: "5.10.4"
+  # The lower bound from the pyproject.toml file
+  OLDEST_PYMC_VERSION: "$(grep -E 'pymc *>' pyproject.toml | sed -n 's/.*>=\\([0-9]*\\.[0-9]*\\.[0-9]*\\).*/\\1/p')"
 
 jobs:
-  test:
+  pre-commit:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        config: [ {python-version: "3.9", oldest-pymc: false}, {python-version: "3.11", oldest-pymc: true}]
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v3
-        with:
-          python-version: ${{ matrix.config.python-version }}
-      - name: Install oldest version of PyMC
-        if: ${{ matrix.config.oldest-pymc }}
-        run: pip install pymc==${{ env.OLDEST_PYMC_VERSION }}
-      - name: Run tests
-        run: |
-          pip install -e .[test]
-          pytest --cov-report=xml --no-cov-on-fail --durations=50
-      - name: Check oldest version of PyMC
-        if: ${{ matrix.config.oldest-pymc }}
-        run: python -c "import pymc; assert pymc.__version__ == '${{ env.OLDEST_PYMC_VERSION }}'"
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }} # use token for more robust uploads
-          name: ${{ matrix.config.python-version }}
-          fail_ci_if_error: false
-
-  test_slow:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v3
-        with:
-          python-version: "3.10"
-      - name: Run tests
-        run: |
-          pip install -e .[test]
-          pytest --only-slow --cov-report=xml --no-cov-on-fail --durations=50
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }} # use token for more robust uploads
-          name: "test_slow"
-          fail_ci_if_error: false
-
-  all:
-    if: ${{ always() }}
-    runs-on: ubuntu-latest
-    name: All checks
-    needs: [ test, test_slow ]
-    steps:
-      - name: Confirm checks passed
-        if: ${{ (needs.test.result != 'success' || needs.test_slow.result != 'success') }}
-        run: exit 1
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/[email protected]

.github/workflows/pypi.yml

@@ -17,7 +17,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Build the sdist and the wheel
         run: |
           pip install build
@@ -27,7 +27,7 @@ jobs:
           mkdir -p test-sdist
           cd test-sdist
           python -m venv venv-sdist
-          venv-sdist/bin/python -m pip install ../dist/pymc-marketing*.tar.gz
+          venv-sdist/bin/python -m pip install ../dist/pymc_marketing*.tar.gz
           echo "Checking import and version number (on release)"
           venv-sdist/bin/python -c "import pymc_marketing as pmm; assert pmm.__version__ == '${{  github.ref_name }}' if '${{ github.ref_type }}' == 'tag' else pmm.__version__; print(pmm.__version__)"
           cd ..
@@ -62,7 +62,7 @@ jobs:
           repository-url: https://test.pypi.org/legacy/
       - uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Test pip install from test.pypi
         run: |
           python -m venv venv-test-pypi

.github/workflows/streamlit_url_health.yml

@@ -0,0 +1,25 @@
+name: URL Health
+
+on:
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  '0 */6 * * *'
+
+jobs:
+
+    build:
+
+        runs-on: ubuntu-latest
+
+        steps:
+        - name: Check the deployed service URL
+          uses: jtalk/url-health-check-action@v4
+          with:
+            # Check the following URLs one by one sequentially
+            url: https://pymc-marketing-app.streamlit.app/
+            # Follow redirects, or just report success on 3xx status codes
+            follow-redirect: false # Optional, defaults to false
+            # Fail this action after this many failed attempts
+            max-attempts: 3 # Optional, defaults to 1
+            # Delay between retries
+            retry-delay: 5s # Optional, only applicable to max-attempts > 1

.github/workflows/test.yml

@@ -0,0 +1,72 @@
+name: Test
+
+on:
+  pull_request:
+    branches: [main]
+    paths: '**.py'
+  push:
+    branches: [main]
+    paths: '**.py'
+
+env:
+  # The lower bound from the pyproject.toml file
+  OLDEST_PYMC_VERSION: "$(grep -E 'pymc *>' pyproject.toml | sed -n 's/.*>=\\([0-9]*\\.[0-9]*\\.[0-9]*\\).*/\\1/p')"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        config: [ {python-version: "3.10", oldest-pymc: false}, {python-version: "3.12", oldest-pymc: true}]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.config.python-version }}
+      - name: Install oldest version of PyMC
+        if: ${{ matrix.config.oldest-pymc }}
+        run: pip install pymc==${{ env.OLDEST_PYMC_VERSION }}
+      - name: Run tests
+        run: |
+          sudo apt-get install graphviz
+          pip install -e .[test]
+          pytest --cov-report=xml --no-cov-on-fail --durations=50
+      - name: Check oldest version of PyMC
+        if: ${{ matrix.config.oldest-pymc }}
+        run: python -c "import pymc; assert pymc.__version__ == '${{ env.OLDEST_PYMC_VERSION }}'"
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }} # use token for more robust uploads
+          name: ${{ matrix.config.python-version }}
+          fail_ci_if_error: false
+
+  test_slow:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+      - name: Run tests
+        run: |
+          pip install -e .[test]
+          pytest --only-slow --cov-report=xml --no-cov-on-fail --durations=50
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }} # use token for more robust uploads
+          name: "test_slow"
+          fail_ci_if_error: false
+
+  all:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    name: All checks
+    needs: [ test, test_slow ]
+    steps:
+      - name: Confirm checks passed
+        if: ${{ (needs.test.result != 'success' || needs.test_slow.result != 'success') }}
+        run: exit 1

.github/workflows/test_notebook.yml

@@ -0,0 +1,30 @@
+name: Test Notebook
+
+on:
+  pull_request:
+    branches: [main]
+    paths:
+      - '**.py'
+      - '**.ipynb'
+  push:
+    branches: [main]
+    paths:
+      - '**.py'
+      - '**.ipynb'
+
+jobs:
+  example_notebooks:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.12"
+    - name: Install dependencies
+      run: |
+        sudo apt-get install graphviz
+        pip install -e .[docs]
+        pip install -e .[test]
+    - name: Run notebooks
+      run: make run_notebooks

.github/workflows/uml.yml

@@ -0,0 +1,49 @@
+name: Update the UML Diagrams
+
+on:
+  pull_request:
+    branches: [main]
+    paths:
+      - "pymc_marketing/**"
+  push:
+    branches: [main]
+    paths:
+      - "pymc_marketing/**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref || 'main' }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+
+      - name: Configure Git Identity
+        run: |
+          git config user.name "$(git log -n 1 --pretty=format:%an)"
+          git config user.email "$(git log -n 1 --pretty=format:%ae)"
+
+      - name: Update the UML Diagrams
+        run: |
+          sudo apt-get update && sudo apt-get install -y graphviz
+          make uml
+
+      - name: Push up the changes
+        run: |
+          git add docs/source/uml/*.png
+          if git diff --staged --exit-code; then
+            echo "No changes to commit"
+          else
+            echo "Committing the changes"
+            git commit -m "Update UML Diagrams"
+            git push origin HEAD:${GITHUB_HEAD_REF:-main}
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,10 @@
+# MLflow logging
+mlruns/
+mlruns.db
+
+# InferenceData
+*.nc
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.pre-commit-config.yaml

@@ -2,32 +2,37 @@ ci:
   autofix_prs: false
 
 repos:
+  - repo: https://github.com/lucianopaz/head_of_apache
+    rev: "0.0.3"
+    hooks:
+      - id: head_of_apache
+        args:
+          - --author=The PyMC Labs Developers
+          - --exclude=docs/
+          - --exclude=scripts/
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.4
+    rev: v0.6.1
     hooks:
       - id: ruff
+        types_or: [python, pyi, jupyter]
         args: ["--fix", "--output-format=full"]
+        exclude: ^docs/source/notebooks/clv/dev/
       - id: ruff-format
+        types_or: [python, pyi, jupyter]
+        exclude: ^docs/source/notebooks/clv/dev/
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.9.0
+    rev: v1.11.1
     hooks:
       - id: mypy
         args: [--ignore-missing-imports]
         files: ^pymc_marketing/
         additional_dependencies: [numpy>=1.20, pandas-stubs]
-  - repo: https://github.com/nbQA-dev/nbQA
-    rev: 1.8.5
-    hooks:
-    - id: nbqa-ruff
-      args: ["--fix", "--output-format=full"]
-      files: ^docs/source/notebooks/
-      exclude: ^docs/source/notebooks/clv/dev/
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: debug-statements
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
       - id: check-added-large-files
-        exclude: ^notebooks/
+        exclude: ^docs/source/notebooks/

CONTRIBUTING.md

@@ -128,24 +128,29 @@ We recommend that your contribution complies with the following guidelines befor
   ```bash
   make check_lint
   ```
-  If you want to fix linting errors automatically, run
+- If you want to fix linting errors automatically, run
 
   ```bash
   make lint
   ```
 
-1. To run tests:
+- To run tests:
 
     ```bash
     make test
     ```
 
-6. To check code style:
+- To check code style:
 
     ```bash
-    make check_lint
+    make check_format
     ```
 
+- To fix code style automatically:
+
+    ```bash
+    make format
+    ```
 
 ## Overview of the MMM codebase
 
@@ -169,4 +174,4 @@ Classes
 
 ---
 
-This guide takes some inspiration from the [Bambi guide to contributing](https://github.com/bambinos/bambi/blob/main/docs/CONTRIBUTING.md)
+This guide takes some inspiration from the [Bambi guide to contributing](https://github.com/bambinos/bambi/blob/main/CONTRIBUTING.md)