churnkit 0.75.0a3__tar.gz

churnkit-0.75.0a3/.gitignore

@@ -0,0 +1,59 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/xs
+*.swp
+*.swo
+.DS_Store
+
+# Testing
+.pytest_cache/
+tests/.coverage
+tests/htmlcov/
+.tox/
+.nox/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Project specific
+*.log
+
+# Test fixtures - large datasets (not included in repo)
+tests/fixtures/bank_customer_churn.csv
+tests/fixtures/netflix_customer_churn.csv
+#tests/fixtures/customer_emails.csv
+#tests/fixtures/customer_transactions.csv
+# Note: customer_retention_retail.csv IS committed (required for CI tests)
+
+# Experiments outputs (all generated data - gitignored)
+experiments/
+
+# Generated pipelines (transient outputs, can be regenerated)
+generated_pipelines/

churnkit-0.75.0a3/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Hristo Aladjov
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

churnkit-0.75.0a3/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: churnkit
+Version: 0.75.0a3
+Summary: Structured ML framework for customer churn prediction -- from exploration notebooks to production pipelines, locally or on Databricks.
+Project-URL: Homepage, https://github.com/aladjov/CR
+Project-URL: Documentation, https://github.com/aladjov/CR/wiki
+Project-URL: Repository, https://github.com/aladjov/CR
+Project-URL: Issues, https://github.com/aladjov/CR/issues
+Author: Customer Retention Contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: churn-prediction,customer-retention,databricks,delta-lake,feast,machine-learning,mlflow,mlops
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: fsspec>=2023.0.0
+Requires-Dist: ipykernel>=7.1.0
+Requires-Dist: kaleido>=0.2.1
+Requires-Dist: matplotlib>=3.7.0
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: papermill>=2.4.0
+Requires-Dist: plotly>=5.15.0
+Requires-Dist: pyarrow>=12.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: s3fs>=2023.0.0
+Requires-Dist: scipy>=1.10.0
+Requires-Dist: seaborn>=0.12.0
+Requires-Dist: statsmodels>=0.14.0
+Requires-Dist: tabulate>=0.9.0
+Provides-Extra: all
+Requires-Dist: deltalake>=0.17.0; extra == 'all'
+Requires-Dist: feast>=0.40.0; extra == 'all'
+Requires-Dist: imbalanced-learn>=0.12.0; extra == 'all'
+Requires-Dist: lightgbm>=4.0.0; extra == 'all'
+Requires-Dist: mlflow>=2.10.0; extra == 'all'
+Requires-Dist: scikit-learn>=1.3.0; extra == 'all'
+Requires-Dist: sentence-transformers>=2.7.0; extra == 'all'
+Requires-Dist: xgboost>=2.0.0; extra == 'all'
+Provides-Extra: all-shap
+Requires-Dist: deltalake>=0.17.0; extra == 'all-shap'
+Requires-Dist: feast>=0.40.0; extra == 'all-shap'
+Requires-Dist: imbalanced-learn>=0.12.0; extra == 'all-shap'
+Requires-Dist: lightgbm>=4.0.0; extra == 'all-shap'
+Requires-Dist: llvmlite<0.46.0,>=0.43.0; (python_version < '3.11') and extra == 'all-shap'
+Requires-Dist: llvmlite>=0.46.0; (python_version >= '3.11') and extra == 'all-shap'
+Requires-Dist: mlflow>=2.10.0; extra == 'all-shap'
+Requires-Dist: numba<0.63.0,>=0.59.0; (python_version < '3.11') and extra == 'all-shap'
+Requires-Dist: numba>=0.63.0; (python_version >= '3.11') and extra == 'all-shap'
+Requires-Dist: scikit-learn>=1.3.0; extra == 'all-shap'
+Requires-Dist: sentence-transformers>=2.7.0; extra == 'all-shap'
+Requires-Dist: shap<0.50.0,>=0.44.0; (python_version < '3.11') and extra == 'all-shap'
+Requires-Dist: shap>=0.50.0; (python_version >= '3.11') and extra == 'all-shap'
+Requires-Dist: xgboost>=2.0.0; extra == 'all-shap'
+Provides-Extra: delta
+Requires-Dist: deltalake>=0.17.0; extra == 'delta'
+Provides-Extra: dev
+Requires-Dist: jinja2>=3.0.0; extra == 'dev'
+Requires-Dist: nbconvert>=7.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.7.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.2.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: ml
+Requires-Dist: deltalake>=0.17.0; extra == 'ml'
+Requires-Dist: feast>=0.40.0; extra == 'ml'
+Requires-Dist: imbalanced-learn>=0.12.0; extra == 'ml'
+Requires-Dist: lightgbm>=4.0.0; extra == 'ml'
+Requires-Dist: mlflow>=2.10.0; extra == 'ml'
+Requires-Dist: scikit-learn>=1.3.0; extra == 'ml'
+Requires-Dist: xgboost>=2.0.0; extra == 'ml'
+Provides-Extra: ml-cpu
+Requires-Dist: deltalake>=0.17.0; extra == 'ml-cpu'
+Requires-Dist: feast>=0.40.0; extra == 'ml-cpu'
+Requires-Dist: imbalanced-learn>=0.12.0; extra == 'ml-cpu'
+Requires-Dist: lightgbm>=4.0.0; extra == 'ml-cpu'
+Requires-Dist: mlflow>=2.10.0; extra == 'ml-cpu'
+Requires-Dist: scikit-learn>=1.3.0; extra == 'ml-cpu'
+Requires-Dist: torch>=2.2.0; extra == 'ml-cpu'
+Requires-Dist: torchvision>=0.17.0; extra == 'ml-cpu'
+Requires-Dist: xgboost>=2.0.0; extra == 'ml-cpu'
+Provides-Extra: ml-cuda
+Requires-Dist: deltalake>=0.17.0; extra == 'ml-cuda'
+Requires-Dist: feast>=0.40.0; extra == 'ml-cuda'
+Requires-Dist: imbalanced-learn>=0.12.0; extra == 'ml-cuda'
+Requires-Dist: lightgbm>=4.0.0; extra == 'ml-cuda'
+Requires-Dist: mlflow>=2.10.0; extra == 'ml-cuda'
+Requires-Dist: scikit-learn>=1.3.0; extra == 'ml-cuda'
+Requires-Dist: torch>=2.2.0; extra == 'ml-cuda'
+Requires-Dist: torchvision>=0.17.0; extra == 'ml-cuda'
+Requires-Dist: xgboost>=2.0.0; extra == 'ml-cuda'
+Provides-Extra: ml-shap
+Requires-Dist: deltalake>=0.17.0; extra == 'ml-shap'
+Requires-Dist: feast>=0.40.0; extra == 'ml-shap'
+Requires-Dist: imbalanced-learn>=0.12.0; extra == 'ml-shap'
+Requires-Dist: lightgbm>=4.0.0; extra == 'ml-shap'
+Requires-Dist: llvmlite<0.46.0,>=0.43.0; (python_version < '3.11') and extra == 'ml-shap'
+Requires-Dist: llvmlite>=0.46.0; (python_version >= '3.11') and extra == 'ml-shap'
+Requires-Dist: mlflow>=2.10.0; extra == 'ml-shap'
+Requires-Dist: numba<0.63.0,>=0.59.0; (python_version < '3.11') and extra == 'ml-shap'
+Requires-Dist: numba>=0.63.0; (python_version >= '3.11') and extra == 'ml-shap'
+Requires-Dist: scikit-learn>=1.3.0; extra == 'ml-shap'
+Requires-Dist: shap<0.50.0,>=0.44.0; (python_version < '3.11') and extra == 'ml-shap'
+Requires-Dist: shap>=0.50.0; (python_version >= '3.11') and extra == 'ml-shap'
+Requires-Dist: xgboost>=2.0.0; extra == 'ml-shap'
+Provides-Extra: ml-shap-intel
+Requires-Dist: deltalake>=0.17.0; extra == 'ml-shap-intel'
+Requires-Dist: feast>=0.40.0; extra == 'ml-shap-intel'
+Requires-Dist: imbalanced-learn>=0.12.0; extra == 'ml-shap-intel'
+Requires-Dist: lightgbm>=4.0.0; extra == 'ml-shap-intel'
+Requires-Dist: llvmlite<0.46.0,>=0.43.0; extra == 'ml-shap-intel'
+Requires-Dist: mlflow>=2.10.0; extra == 'ml-shap-intel'
+Requires-Dist: numba<0.63.0,>=0.59.0; extra == 'ml-shap-intel'
+Requires-Dist: scikit-learn>=1.3.0; extra == 'ml-shap-intel'
+Requires-Dist: shap<0.50.0,>=0.44.0; extra == 'ml-shap-intel'
+Requires-Dist: xgboost>=2.0.0; extra == 'ml-shap-intel'
+Provides-Extra: text
+Requires-Dist: sentence-transformers>=2.7.0; extra == 'text'
+Description-Content-Type: text/markdown
+
+# Customer Retention ML Framework
+A structured backbone for the messy, iterative reality of ML model development. Exploration and production deployment are treated as parts of the same process -- not separate phases -- reflecting how data science actually works: you explore, decide, build, evaluate, learn something new, and circle back.
+
+Handles both entity-level and event-level datasets. Experiments and production can share the same tables without copying data (Delta Lake), features are served consistently across training and inference (Feast / Feature Store), and every experiment is tracked and reproducible (MLflow). Runs locally or deploys to Databricks.
+
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-green.svg)](LICENSE)
+[![CI](https://github.com/aladjov/CR/actions/workflows/ci.yaml/badge.svg)](https://github.com/aladjov/CR/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/aladjov/CR/branch/master/graph/badge.svg)](https://codecov.io/gh/aladjov/CR)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![Typed](https://img.shields.io/badge/typed-Pydantic-blue)](https://docs.pydantic.dev/)
+[![MLflow](https://img.shields.io/badge/MLflow-integrated-0194E2?logo=mlflow)](https://mlflow.org/)
+[![Databricks](https://img.shields.io/badge/Databricks-compatible-FF3621?logo=databricks)](https://databricks.com/)
+
+---
+
+## Why This Exists
+
+Most ML tutorials jump straight to `model.fit()`. Real projects fail earlier -- in data issues you didn't notice, leakage you didn't check for, or feature choices you can't explain to your stakeholders three months later. This framework tries to close that gap.
+
+It serves two audiences:
+
+1. **If you're learning**, the notebooks walk through a realistic end-to-end process and explain the reasoning behind each step. Why does a 93-day median inter-event gap rule out short aggregation windows? Why might the model that wins validation degrade in production? The goal is to build intuition for the decisions that don't appear in textbooks.
+
+2. **If you're experienced**, you can `pip install`, point to a new dataset, and get an opinionated exploration scaffold. The output is loosely-coupled production code (Bronze / Silver / Gold) with the provenance of every decision captured in self-contained HTML documentation -- useful when you need to explain *why* the pipeline does what it does.
+
+### The approach
+
+- **Exploration is a first-class concept.** The framework records what it found in the data, what it recommends, and why -- in versioned YAML artifacts. Each downstream transformation traces back to a specific observation in a specific notebook, so nothing happens without a documented reason.
+- **Experimentation is version-controlled end to end.** Not just code and features, but the actual data observations and actions taken on them can be frozen in time together. Delta tables support time-travel on live production datasets, so you can always go back to what the data looked like when a decision was made.
+- **Iteration is the default.** Model feedback -- feature importances, error analysis, drift signals -- feeds back into the next exploration cycle. The framework tracks iteration lineage rather than treating each experiment as independent.
+
+---
+
+## Quick Start
+
+### 1. Install
+
+```bash
+pip install "churnkit[ml]"
+```
+
+### 2. Bootstrap notebooks into your project
+
+```bash
+churnkit-init --output ./my_project
+cd my_project
+```
+
+### 3. Point to your data
+
+Open `exploration_notebooks/01_data_discovery.ipynb` and set the data path:
+
+```python
+DATA_PATH = "experiments/data/your_file.csv"   # csv, parquet, or delta
+```
+
+### 4. Run
+
+Execute cells sequentially. The framework auto-detects column types, data granularity (entity vs event-level), text columns, and temporal patterns -- then routes you through the relevant notebooks.
+
+Findings, recommendations, and production pipeline specs are generated as you go.
+
+---
+
+## Learn More
+
+Detailed documentation lives in the [Wiki](https://github.com/aladjov/CR/wiki):
+
+| Topic | Wiki Page |
+|-------|-----------|
+| Installation options & environment setup | [Getting Started](https://github.com/aladjov/CR/wiki/Getting-Started) |
+| Medallion architecture & system design | [Architecture](https://github.com/aladjov/CR/wiki/Architecture) |
+| Notebook workflow & iteration tracking | [Exploration Loop](https://github.com/aladjov/CR/wiki/Exploration-Loop) |
+| Leakage-safe temporal data preparation | [Temporal Framework](https://github.com/aladjov/CR/wiki/Temporal-Framework) |
+| Feast & Databricks feature management | [Feature Store](https://github.com/aladjov/CR/wiki/Feature-Store) |
+| Local execution with Feast + MLFlow | [Local Track](https://github.com/aladjov/CR/wiki/Local-Track) |
+| Databricks with Unity Catalog + Delta Lake | [Databricks Track](https://github.com/aladjov/CR/wiki/Databricks-Track) |
+
+### Tutorials
+
+| Tutorial | What it walks through |
+|----------|-----------------------|
+| [Retail Customer Retention](https://github.com/aladjov/CR/wiki/Tutorial-Retail-Churn) | Entity-level data: point-in-time snapshots, quality assessment, baseline models, and a production scoring check that reveals how distribution drift affects different model families -- [browse HTML](https://aladjov.github.io/CR/tutorial/retail-churn/) |
+| [Customer Email Engagement](https://github.com/aladjov/CR/wiki/Tutorial-Customer-Emails) | Event-level data: temporal window selection driven by inter-event cadence, aggregating 83K email events into customer-level features, and tracing each decision from data observation to production pipeline -- [browse HTML](https://aladjov.github.io/CR/tutorial/customer-emails/) |
+| [Bank Customer Churn](https://github.com/aladjov/CR/wiki/Tutorial-Bank-Churn) | Dataset setup instructions |
+| [Netflix Churn](https://github.com/aladjov/CR/wiki/Tutorial-Netflix-Churn) | Dataset setup instructions |
+
+### [Acknowledgments](https://github.com/aladjov/CR/wiki/Acknowledgments)
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+Apache 2.0 -- See [LICENSE](LICENSE) for details.

churnkit-0.75.0a3/README.md

@@ -0,0 +1,99 @@
+# Customer Retention ML Framework
+A structured backbone for the messy, iterative reality of ML model development. Exploration and production deployment are treated as parts of the same process -- not separate phases -- reflecting how data science actually works: you explore, decide, build, evaluate, learn something new, and circle back.
+
+Handles both entity-level and event-level datasets. Experiments and production can share the same tables without copying data (Delta Lake), features are served consistently across training and inference (Feast / Feature Store), and every experiment is tracked and reproducible (MLflow). Runs locally or deploys to Databricks.
+
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-green.svg)](LICENSE)
+[![CI](https://github.com/aladjov/CR/actions/workflows/ci.yaml/badge.svg)](https://github.com/aladjov/CR/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/aladjov/CR/branch/master/graph/badge.svg)](https://codecov.io/gh/aladjov/CR)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![Typed](https://img.shields.io/badge/typed-Pydantic-blue)](https://docs.pydantic.dev/)
+[![MLflow](https://img.shields.io/badge/MLflow-integrated-0194E2?logo=mlflow)](https://mlflow.org/)
+[![Databricks](https://img.shields.io/badge/Databricks-compatible-FF3621?logo=databricks)](https://databricks.com/)
+
+---
+
+## Why This Exists
+
+Most ML tutorials jump straight to `model.fit()`. Real projects fail earlier -- in data issues you didn't notice, leakage you didn't check for, or feature choices you can't explain to your stakeholders three months later. This framework tries to close that gap.
+
+It serves two audiences:
+
+1. **If you're learning**, the notebooks walk through a realistic end-to-end process and explain the reasoning behind each step. Why does a 93-day median inter-event gap rule out short aggregation windows? Why might the model that wins validation degrade in production? The goal is to build intuition for the decisions that don't appear in textbooks.
+
+2. **If you're experienced**, you can `pip install`, point to a new dataset, and get an opinionated exploration scaffold. The output is loosely-coupled production code (Bronze / Silver / Gold) with the provenance of every decision captured in self-contained HTML documentation -- useful when you need to explain *why* the pipeline does what it does.
+
+### The approach
+
+- **Exploration is a first-class concept.** The framework records what it found in the data, what it recommends, and why -- in versioned YAML artifacts. Each downstream transformation traces back to a specific observation in a specific notebook, so nothing happens without a documented reason.
+- **Experimentation is version-controlled end to end.** Not just code and features, but the actual data observations and actions taken on them can be frozen in time together. Delta tables support time-travel on live production datasets, so you can always go back to what the data looked like when a decision was made.
+- **Iteration is the default.** Model feedback -- feature importances, error analysis, drift signals -- feeds back into the next exploration cycle. The framework tracks iteration lineage rather than treating each experiment as independent.
+
+---
+
+## Quick Start
+
+### 1. Install
+
+```bash
+pip install "churnkit[ml]"
+```
+
+### 2. Bootstrap notebooks into your project
+
+```bash
+churnkit-init --output ./my_project
+cd my_project
+```
+
+### 3. Point to your data
+
+Open `exploration_notebooks/01_data_discovery.ipynb` and set the data path:
+
+```python
+DATA_PATH = "experiments/data/your_file.csv"   # csv, parquet, or delta
+```
+
+### 4. Run
+
+Execute cells sequentially. The framework auto-detects column types, data granularity (entity vs event-level), text columns, and temporal patterns -- then routes you through the relevant notebooks.
+
+Findings, recommendations, and production pipeline specs are generated as you go.
+
+---
+
+## Learn More
+
+Detailed documentation lives in the [Wiki](https://github.com/aladjov/CR/wiki):
+
+| Topic | Wiki Page |
+|-------|-----------|
+| Installation options & environment setup | [Getting Started](https://github.com/aladjov/CR/wiki/Getting-Started) |
+| Medallion architecture & system design | [Architecture](https://github.com/aladjov/CR/wiki/Architecture) |
+| Notebook workflow & iteration tracking | [Exploration Loop](https://github.com/aladjov/CR/wiki/Exploration-Loop) |
+| Leakage-safe temporal data preparation | [Temporal Framework](https://github.com/aladjov/CR/wiki/Temporal-Framework) |
+| Feast & Databricks feature management | [Feature Store](https://github.com/aladjov/CR/wiki/Feature-Store) |
+| Local execution with Feast + MLFlow | [Local Track](https://github.com/aladjov/CR/wiki/Local-Track) |
+| Databricks with Unity Catalog + Delta Lake | [Databricks Track](https://github.com/aladjov/CR/wiki/Databricks-Track) |
+
+### Tutorials
+
+| Tutorial | What it walks through |
+|----------|-----------------------|
+| [Retail Customer Retention](https://github.com/aladjov/CR/wiki/Tutorial-Retail-Churn) | Entity-level data: point-in-time snapshots, quality assessment, baseline models, and a production scoring check that reveals how distribution drift affects different model families -- [browse HTML](https://aladjov.github.io/CR/tutorial/retail-churn/) |
+| [Customer Email Engagement](https://github.com/aladjov/CR/wiki/Tutorial-Customer-Emails) | Event-level data: temporal window selection driven by inter-event cadence, aggregating 83K email events into customer-level features, and tracing each decision from data observation to production pipeline -- [browse HTML](https://aladjov.github.io/CR/tutorial/customer-emails/) |
+| [Bank Customer Churn](https://github.com/aladjov/CR/wiki/Tutorial-Bank-Churn) | Dataset setup instructions |
+| [Netflix Churn](https://github.com/aladjov/CR/wiki/Tutorial-Netflix-Churn) | Dataset setup instructions |
+
+### [Acknowledgments](https://github.com/aladjov/CR/wiki/Acknowledgments)
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+Apache 2.0 -- See [LICENSE](LICENSE) for details.