A lightweight tool to calculate Predictive Integrity (PI) for PyTorch models.
Project description
ΣPI: Observe the Cognitive ability of Your AI Model
ΣPI is a lightweight, universal SDK to calculate Predictive Integrity (PI), a metric from the Integrated Predictive Workspace Theory (IPWT) of consciousness. It provides a powerful, real-time proxy for your model's "cognitive state" during training.
Stop just looking at loss. Start observing how your model learns.
What is Predictive Integrity (PI)?
PI is a score (0 to 1) reflecting a model's internal world model integrity, derived from prediction error (Epsilon), model uncertainty (Tau), and global gradient norm (Surprise). High PI indicates healthy learning; a drop can signal issues like overfitting before loss metrics do.
Why Use ΣPI?
- Early Warning for Training Instability: Detects subtle shifts in model "cognition" before loss metrics diverge.
- Insight into OOD Impact: Quantifies the "surprise" your model experiences when encountering out-of-distribution data.
- Understanding Model Overfitting: Reveals when your model's internal world becomes too rigid or too chaotic.
- Quantifying Cognitive Load: Provides a novel metric for the "effort" your model expends to integrate new information.
Model Zoo & Experiments
Our test suite is now centered around a lightweight (~1M parameter) Vision Transformer architecture to facilitate rapid experimentation on cognitive learning principles. We compare three main variants on CIFAR-10, using SVHN as an Out-of-Distribution (OOD) validation set.
The goal is to observe how different learning strategies perform under resource constraints, providing a clearer view of the benefits of mechanisms like Gated Backpropagation (GBP).
"Don't just train your model. Understand its mind."
| Baseline ViT | 4x1 MoE-ViT | 16x4 MoE-ViT | 16x4 GBP-MoE-ViT with 3σ Learning |
|---|---|---|---|
| ~0.81M | ~1.21M | ~1.23M | ~1.23M |
Old result (CNN, ResNet...) in here.
Installation
pip install sigma-pi
How to Use
The sigma-pi package provides the core SigmaPI monitor. To replicate the experiments and use the full testing framework, you must first clone the repository.
git clone https://github.com/dmf-archive/SigmaPI.git
cd SigmaPI
Note: This package does not automatically install PyTorch. Please manually install the appropriate version for your system (CPU or CUDA) before proceeding.
After setting up PyTorch, install the testing framework dependencies:
pip install -e .[dev]
The testing framework is modular and configuration-driven.
1. Configure Your Experiment
Create or modify a configuration file in test/configs/. For example, test/configs/base_vit.py:
# test/configs/base_vit.py
# Model parameters
model_config = {
'model_type': 'base',
'embed_dim': 128,
'depth': 6,
# ... other model params
}
# Training parameters
train_config = {
'epochs': 20,
'batch_size': 256,
# ... other training params
}
2. Run the Experiment
Launch the experiment from the root directory using the test/run_experiment.py script:
python test/run_experiment.py --config test/configs/base_vit.py
To run the other variants, simply point to their respective config files:
# Run MoE-ViT experiment
python test/run_experiment.py --config test/configs/moe_vit.py
# Run GBP-MoE-ViT experiment
python test/run_experiment.py --config test/configs/gbp_moe_vit.py
3. Integrating ΣPI
# (Inside the training/validation loop)
# Calculate loss
loss_epsilon = loss_fn(logits, target)
# Compute gradients
model.zero_grad()
loss_epsilon.backward()
# Calculate PI metrics
pi_metrics = pi_monitor.calculate(
model=model,
loss_epsilon=loss_epsilon,
logits=logits
)
print(f"PI: {pi_metrics['pi_score']:.4f}, Surprise: {pi_metrics['surprise']:.4f}")
The returned pi_metrics dictionary contains:
pi_score: The overall predictive integrity (0-1)surprise: Gradient norm indicating model adaptationnormalized_error: Error scaled by model uncertaintycognitive_cost: Combined cost of error and surprise- Additional component metrics for detailed analysis
Further Reading
PI is a concept derived from the Integrated Predictive Workspace Theory (IPWT), a computational theory of consciousness. To understand the deep theory behind this tool, please refer to https://github.com/dmf-archive/IPWT
Citation
If you wish to cite this work, please use the following BibTeX entry:
@misc{sigma_pi,
author = {Rui, L.},
title = {{ΣPI: Observe the Cognitive ability of Your AI Model}},
year = {2025},
publisher = {GitHub},
url = {https://github.com/dmf-archive/SigmaPI}
}
License
This project is licensed under the MIT License.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sigma_pi-0.2.0.tar.gz.
File metadata
- Download URL: sigma_pi-0.2.0.tar.gz
- Upload date:
- Size: 33.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fe4372e9b79f3a8e56745c6280206343a04e5e919928f08e1c71c880c4495cd8
|
|
| MD5 |
5b2a8788758604ac464320d16834d476
|
|
| BLAKE2b-256 |
f45b540d3906154aed5314ead496c315088e5f3581d6b293933e02738369be3b
|
Provenance
The following attestation bundles were made for sigma_pi-0.2.0.tar.gz:
Publisher:
publish-to-pypi.yml on dmf-archive/SigmaPI
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sigma_pi-0.2.0.tar.gz -
Subject digest:
fe4372e9b79f3a8e56745c6280206343a04e5e919928f08e1c71c880c4495cd8 - Sigstore transparency entry: 253233710
- Sigstore integration time:
-
Permalink:
dmf-archive/SigmaPI@1bb80bcb1d1968f574e0904213b7a2bea22e9c70 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/dmf-archive
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@1bb80bcb1d1968f574e0904213b7a2bea22e9c70 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sigma_pi-0.2.0-py3-none-any.whl.
File metadata
- Download URL: sigma_pi-0.2.0-py3-none-any.whl
- Upload date:
- Size: 6.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ffa84627724c154077473a1e75a899b8761349742bf7bc9dfdf9ccfa6d3e9b52
|
|
| MD5 |
ec95859982e5b1d9f3a18d17001c55a0
|
|
| BLAKE2b-256 |
5247ee9abecdb6a3a425f7aebd28d42757c8eeae225d23c31ceb5748a97ca89c
|
Provenance
The following attestation bundles were made for sigma_pi-0.2.0-py3-none-any.whl:
Publisher:
publish-to-pypi.yml on dmf-archive/SigmaPI
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sigma_pi-0.2.0-py3-none-any.whl -
Subject digest:
ffa84627724c154077473a1e75a899b8761349742bf7bc9dfdf9ccfa6d3e9b52 - Sigstore transparency entry: 253233720
- Sigstore integration time:
-
Permalink:
dmf-archive/SigmaPI@1bb80bcb1d1968f574e0904213b7a2bea22e9c70 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/dmf-archive
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@1bb80bcb1d1968f574e0904213b7a2bea22e9c70 -
Trigger Event:
push
-
Statement type: