Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Unified IG

Unified IG provides one small, SHAP-like API for Integrated Gradients across model families. The first implementation supports closed-form attributions for scikit-learn linear models and multilayer perceptrons.

import unifiedig as uig

explainer = uig.Explainer(model, baseline)
explanation = explainer(X)

For numerical backends, the quadrature resolution is configurable:

explainer = uig.Explainer(model, baseline, n_steps=128)

Explanation is lightweight and has SHAP-compatible fields. SHAP remains an optional dependency; call explanation.to_shap() to use its plotting tools.

Installation

During development, install the project and its test dependencies with:

python -m pip install -e ".[test]"

Output semantics

For regression, attributions sum to the difference between the prediction and the baseline prediction. Binary classifiers are explained on their decision-score (logit) scale; probability attributions are not part of V1. See docs/semantics.md for the complete array-shape and output contract.

Numerical explanations expose their observed completeness residual:

explanation.completeness_error
explanation.max_abs_completeness_error

Unified IG warns when this error exceeds the configured tolerance. Increasing n_steps usually improves it. See the examples/ directory for complete linear, logistic, MLP regression, and MLP classification programs.

Supported models

  • sklearn.linear_model.LinearRegression (closed form)
  • Binary sklearn.linear_model.LogisticRegression (closed form)
  • sklearn.neural_network.MLPRegressor (analytic gradients and quadrature)
  • Binary sklearn.neural_network.MLPClassifier (analytic logit gradients and quadrature)
  • PyTorch modules with one raw scalar output per sample (Captum, optional)

Install PyTorch support separately so the core package remains lightweight:

pip install "unifiedig[torch]"

PyTorch models may accept tabular or structured single-tensor inputs. Unified IG preserves the model's device and floating-point dtype, temporarily evaluates the model in inference mode, and restores every module's prior training state. V1 expects one raw scalar output per sample. For binary classification that output must be the logit, not a sigmoid probability.

Development

Run the tests and validate distribution artifacts with:

pytest
python -m build
python -m twine check dist/*

See CONTRIBUTING.md for the development workflow.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unifiedig-0.1.0.dev2.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unifiedig-0.1.0.dev2-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file unifiedig-0.1.0.dev2.tar.gz.

File metadata

  • Download URL: unifiedig-0.1.0.dev2.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for unifiedig-0.1.0.dev2.tar.gz
Algorithm Hash digest
SHA256 f53349f6201ffb071b2a082a431cd953b3eaa1222959171676c784983e7f2409
MD5 cddca3b7774ca355baf5a979a2ea6a57
BLAKE2b-256 6e1100ad2be5814e2fec2a9410862308cc195a21663e3ba7330db2311ec1d234

See more details on using hashes here.

Provenance

The following attestation bundles were made for unifiedig-0.1.0.dev2.tar.gz:

Publisher: release.yml on LudgerHentschel/unifiedig

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file unifiedig-0.1.0.dev2-py3-none-any.whl.

File metadata

  • Download URL: unifiedig-0.1.0.dev2-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for unifiedig-0.1.0.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 3721dd0944c0b05a8e23f1f8b0faab3393f70dc515d5470c59b5eeca6eeb90bf
MD5 f4f3fed5351a2a086e938e7b421760d7
BLAKE2b-256 be76a86c7f57efc1f50d175601c8545c8cc83ca5acbb3a5b290f0664184f2023

See more details on using hashes here.

Provenance

The following attestation bundles were made for unifiedig-0.1.0.dev2-py3-none-any.whl:

Publisher: release.yml on LudgerHentschel/unifiedig

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.6

2 files

0.1.0

2 files

This release

0.1.0.dev2 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page