modeldiff-ml 0.1.0__tar.gz

modeldiff_ml-0.1.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,50 @@
+name: Publish modeldiff-ml to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+      - name: Install build frontend
+        run: python -m pip install build
+      - name: Build wheel and source distribution
+        run: python -m build
+      - name: Store distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    name: Publish distribution to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/modeldiff-ml
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

modeldiff_ml-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

modeldiff_ml-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ethan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

modeldiff_ml-0.1.0/PKG-INFO

@@ -0,0 +1,251 @@
+Metadata-Version: 2.5
+Name: modeldiff-ml
+Version: 0.1.0
+Summary: Behavioral regression testing for machine-learning models
+Project-URL: Homepage, https://github.com/ecklein/modeldiff-ml
+Project-URL: Repository, https://github.com/ecklein/modeldiff-ml
+Project-URL: Issues, https://github.com/ecklein/modeldiff-ml/issues
+Author-email: Ethan Klein <ethan.kleinc@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 ethan
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: machine-learning,model-comparison,regression-testing,statistics
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.24
+Requires-Dist: pandas>=2.0
+Requires-Dist: scipy>=1.10
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pandas-stubs>=2.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: scikit-learn>=1.4; extra == 'dev'
+Requires-Dist: scipy-stubs>=1.10; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# ModelDiff-ML
+
+Your candidate model improved AUC from 0.84 to 0.85. But did it get better everywhere?
+
+ModelDiff-ML compares two machine-learning models at the observation level and automatically
+discovers interpretable, statistically validated regions where the candidate behaves differently
+from the baseline. It is a small Python library built around NumPy, pandas, and SciPy—not an MLOps
+platform.
+
+```text
+ordinary evaluation:  "The average metric improved."
+ModelDiff-ML:          "It improved overall, but regressed for high-x1, low-x2 observations."
+```
+
+## Installation
+
+ModelDiff-ML requires Python 3.11 or newer. The distribution is named `modeldiff-ml`; its
+Python import package remains the concise `modeldiff`.
+
+```bash
+pip install modeldiff-ml
+```
+
+For local development:
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+pip install -e '.[dev]'
+pytest
+```
+
+## Quickstart
+
+ModelDiff-ML supports fitted sklearn-style models:
+
+```python
+import modeldiff
+
+report = modeldiff.compare(
+    baseline=old_model,
+    candidate=new_model,
+    X=X_test,
+    y=y_test,
+    task="binary_classification",
+    metric="log_loss",
+    random_state=42,
+)
+
+print(report.summary())
+report.to_json("modeldiff-ml.json")
+report.to_html("modeldiff-ml.html")
+```
+
+Binary classifiers must expose `predict_proba(X)` with two columns. ModelDiff-ML deliberately does not
+turn an estimator's uncalibrated `decision_function` into a probability. Regression estimators need
+only `predict(X)`.
+
+## Raw predictions
+
+The framework is model-agnostic when predictions are already available:
+
+```python
+from modeldiff import ModelDiffConfig, compare_predictions
+
+config = ModelDiffConfig(
+    max_depth=3,
+    min_region_fraction=0.02,
+    n_bootstrap=1000,
+    n_permutations=2000,
+    random_state=42,
+)
+
+report = compare_predictions(
+    baseline_predictions=old_probabilities,
+    candidate_predictions=new_probabilities,
+    X=X_test,
+    y=y_test,
+    task="binary_classification",
+    metric="log_loss",
+    config=config,
+)
+
+significant_regressions = report.regressions(significant_only=True)
+```
+
+`X` may be a pandas DataFrame or two-dimensional NumPy array. DataFrames produce more readable
+conditions. Arrays receive the names `x0`, `x1`, and so on.
+
+## Interpreting delta
+
+ModelDiff-ML uses one convention everywhere:
+
+```text
+delta_i = candidate_loss_i - baseline_loss_i
+```
+
+- Positive delta: the candidate is worse.
+- Negative delta: the candidate is better.
+- Zero: equal loss.
+
+The supported classification losses are log loss, Brier loss (`"brier"`), and accuracy loss
+(`"accuracy"`). Classification reports also include accuracy, log loss, Brier score, and rank-based
+ROC AUC. Regression supports squared error (`"squared_error"` or `"mse"`), RMSE (`"rmse"`), and
+absolute error (`"absolute_error"` or `"mae"`).
+
+For RMSE, the overall metric is square-rooted after aggregation; region discovery still operates on
+observation-level squared error. For accuracy, the primary loss is misclassification rate while the
+aggregate metrics table also reports conventional accuracy.
+
+## How region discovery works
+
+1. ModelDiff-ML computes a loss difference for every observation.
+2. It deterministically divides the data into discovery and validation partitions.
+3. Numeric candidate conditions come from empirical quantiles. Categorical candidates use frequent
+   equality and inequality conditions.
+4. A from-scratch beam search builds conjunctions up to `max_depth`, scoring each as
+   `abs(mean_delta) * sqrt(region_fraction)` (with sign-aware variants for each direction).
+5. Highly overlapping regions are removed using Jaccard similarity.
+6. The exact selected conditions are applied unchanged to the validation partition.
+7. Validation effects receive percentile bootstrap confidence intervals and paired sign-flip
+   p-values. Benjamini–Hochberg correction produces q-values across all tested regions.
+
+This separation matters: searching for a threshold and reporting a p-value from those same rows
+would understate selection bias. ModelDiff-ML's independent holdout is a practical first defense.
+
+## Classification example
+
+[`examples/classification_example.py`](examples/classification_example.py) creates a candidate that
+is better overall but deliberately worse when `x1` is high and `x2` is low:
+
+```bash
+python examples/classification_example.py
+```
+
+This is the central ModelDiff-ML use case: aggregate improvement can hide a meaningful local
+regression. A generated standalone report is available at
+[`examples/classification_report.html`](examples/classification_report.html).
+
+## Regression example
+
+[`examples/regression_example.py`](examples/regression_example.py) compares two arrays of regression
+predictions and discovers a planted high-error slice.
+
+## CLI and CI
+
+The CLI reads precomputed predictions from CSV. Unless excluded, columns other than the target and
+prediction columns are features:
+
+```bash
+modeldiff-ml compare \
+  --data validation.csv \
+  --target y \
+  --baseline-pred old_prediction \
+  --candidate-pred new_prediction \
+  --task binary_classification \
+  --metric log_loss \
+  --html report.html \
+  --json report.json
+```
+
+Use `--exclude COLUMN` repeatedly to omit non-feature columns. CI-oriented checks return exit code 1:
+
+```bash
+modeldiff-ml compare ... --fail-on-significant-regression
+modeldiff-ml compare ... --max-overall-regression 0.01
+```
+
+The JSON output has schema version `1.0`, contains no model objects, and is suitable for CI artifact
+processing.
+
+## Configuration
+
+`ModelDiffConfig` controls the discovery fraction, quantile grid, beam width, maximum depth, minimum
+and maximum support, overlap threshold, resampling counts, confidence and significance levels,
+classification threshold, numerical epsilon, and random seed. Defaults favor understandable output
+and avoid tiny slices. Missing feature values are never imputed; they evaluate as false for V1
+conditions.
+
+## Statistical scope and limitations
+
+Discovered subgroups are exploratory. Independent validation and FDR correction reduce false
+discoveries, but do not eliminate them. Results can still be unstable with small data, distribution
+shift, correlated repeated observations, or extensive repeated analyses by a human. A fresh final
+test set is appropriate before high-stakes deployment decisions.
+
+V1 supports binary classification and regression only. It does not include multiclass evaluation,
+causal claims, fairness-specific analysis, time/group-aware splitting, distributed execution, SHAP,
+LLM evaluation, monitoring infrastructure, model registries, dashboards, or automated remediation.
+
+## Roadmap
+
+- Group-aware and time-based validation strategies
+- Multiclass observation-level losses
+- Cross-validated discovery and stability summaries
+- Pluggable, documented region scoring policies
+- Richer calibrated-score adapters
+
+## License
+
+MIT