Skip to main content

Formal verification of neural networks using abstract interpretation and affine arithmetic

Project description

abstractNN

PyPI version Python 3.8+ License: MIT Documentation Status Code style: black

abstractNN is a Python library for formal verification of neural networks using abstract interpretation and affine arithmetic. It provides mathematically sound guarantees about network behavior under input perturbations.

๐ŸŽฏ Key Features

  • Sound Verification: Mathematically proven bounds on network outputs
  • Affine Arithmetic: Symbolic tracking of input-output dependencies
  • Multiple Relaxations: Linear, interval, and hybrid relaxation strategies
  • ONNX Support: Works with models exported from PyTorch, TensorFlow, etc.
  • Partial Evaluation: Efficient verification of network sub-regions
  • Soundness Checking: Monte Carlo validation of formal bounds
  • Production Ready: Well-tested, documented, and type-hinted

๐Ÿ“ฆ Installation

From PyPI (recommended)

pip install abstractNN

From source

git clone https://github.com/guillaume117/abstractNN.git
cd abstractNN
pip install -e .

# Download pre-trained models
chmod +x scripts/download_models.sh
./scripts/download_models.sh

With optional dependencies

# Development tools
pip install abstractNN[dev]

# Documentation building
pip install abstractNN[docs]

# GPU acceleration
pip install abstractNN[gpu]

# Visualization tools
pip install abstractNN[viz]

# All extras
pip install abstractNN[dev,docs,gpu,viz]

๐Ÿš€ Quick Start

Basic Verification

from abstractnn import AffineEngine, BoundPropagator, ONNXParser

# Load your ONNX model
parser = ONNXParser('model.onnx')
layers = parser.parse()

# Create verification engine
engine = AffineEngine()
propagator = BoundPropagator(engine)

# Define perturbed input
import numpy as np
image = np.random.rand(3, 28, 28).astype(np.float32)
noise_level = 0.1  # Lโˆž perturbation radius

# Create symbolic expressions
input_exprs = engine.create_input_expressions(image, noise_level)

# Propagate through network
output_exprs = propagator.propagate(input_exprs, layers, image.shape)

# Get guaranteed output bounds
bounds = [expr.get_bounds() for expr in output_exprs]
print(f"Output bounds: [{bounds[0][0]:.4f}, {bounds[0][1]:.4f}]")

VGG16 Partial Verification

from abstractnn import verify_partial_soundness

# Verify first 5 layers of VGG16
result = verify_partial_soundness(
    model_path='vgg16.onnx',
    image=test_image,
    noise_level=0.01,
    num_layers=5,
    num_mc_samples=100
)

if result['success']:
    print(f"Sound: {result['soundness_report']['is_sound']}")
    print(f"Coverage: {result['soundness_report']['coverage_ratio']*100:.1f}%")

Command Line Interface

# Verify a model
abstractnn-verify --model model.onnx --image test.npy --epsilon 0.01

# Get library info
abstractnn-info

โš ๏ธ Large Model Files

Note: Pre-trained model files (like VGG16) are NOT included in the repository due to their large size (500+ MB).

To download models:

# Option 1: Use download script
./scripts/download_models.sh

# Option 2: Models will be automatically downloaded when running tests
python -m pytest tests/test_vgg16_formal.py

The models will be saved to the models/ directory.

๐Ÿ“š Documentation

Full documentation is available at abstractnn.readthedocs.io

๐Ÿงช Running Tests

# Run all tests
pytest tests/ -v

# Run with coverage
pytest tests/ --cov=abstractnn --cov-report=html

# Run specific test
pytest tests/test_affine_engine.py -v

๐Ÿ—๏ธ Architecture

abstractNN/ โ”œโ”€โ”€ abstractnn/ # Main package โ”‚ โ”œโ”€โ”€ init.py โ”‚ โ”œโ”€โ”€ affine_engine.py # Affine expression management โ”‚ โ”œโ”€โ”€ bound_propagator.py # Layer-by-layer propagation โ”‚ โ”œโ”€โ”€ relaxer.py # Non-linear relaxations โ”‚ โ”œโ”€โ”€ onnx_parser.py # ONNX model parsing โ”‚ โ”œโ”€โ”€ partial_evaluator.py # Partial network evaluation โ”‚ โ”œโ”€โ”€ soundness_checker.py # Soundness validation โ”‚ โ””โ”€โ”€ cli.py # Command-line interface โ”œโ”€โ”€ tests/ # Test suite โ”œโ”€โ”€ docs/ # Sphinx documentation โ”œโ”€โ”€ examples/ # Usage examples โ””โ”€โ”€ scripts/ # Utility scripts

##๐Ÿ”ฌ Research & Citations

If you use abstractNN in your research, please cite:

@software{abstractnn2025,
  title={abstractNN: Formal Verification of Neural Networks using Abstract Interpretation},
  author={Berthelot, Guillaume},
  year={2025},
  url={https://github.com/guillaume117/abstractNN},
  version={0.1.0}
}

๐Ÿค Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

# Setup development environment
git clone https://github.com/flyworthi/abstractNN.git
cd abstractNN
pip install -e .[dev]# Run testspytest tests/# Format codeblack abstractnn/ tests/isort abstractnn/ tests/# Type checkingmypy abstractnn/```## ๐Ÿ“Š Comparison with Other Tools

Tool	Soundness	Scalability	Speed	Tightness
abstractNN	โœ… Yes	โš ๏ธ Medium	โš ๏ธ Medium	โš ๏ธ Good
ERAN	โœ… Yes	โœ… High	โœ… Fast	โš ๏ธ Good
Marabou	โœ… Yes	โŒ Low	โŒ Slow	โœ… Exact
ฮฑ,ฮฒ-CROWN	โœ… Yes	โœ… High	โœ… Fast	โœ… GoodabstractNN/
โ”œโ”€โ”€ abstractnn/           # Main package
โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”œโ”€โ”€ affine_engine.py  # Affine expression management
โ”‚   โ”œโ”€โ”€ bound_propagator.py  # Layer-by-layer propagation
โ”‚   โ”œโ”€โ”€ relaxer.py        # Non-linear relaxations
โ”‚   โ”œโ”€โ”€ onnx_parser.py    # ONNX model parsing
โ”‚   โ”œโ”€โ”€ partial_evaluator.py  # Partial network evaluation
โ”‚   โ”œโ”€โ”€ soundness_checker.py  # Soundness validation
โ”‚   โ””โ”€โ”€ cli.py            # Command-line interface
โ”œโ”€โ”€ tests/                # Test suite
โ”œโ”€โ”€ docs/                 # Sphinx documentation
โ”œโ”€โ”€ examples/             # Usage examples
โ””โ”€โ”€ scripts/              # Utility scripts

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

abstractnn-0.1.0.tar.gz (74.3 kB view details)

Uploaded Source

Built Distribution

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

abstractnn-0.1.0-py3-none-any.whl (47.0 kB view details)

Uploaded Python 3

File details

Details for the file abstractnn-0.1.0.tar.gz.

File metadata

  • Download URL: abstractnn-0.1.0.tar.gz
  • Upload date:
  • Size: 74.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for abstractnn-0.1.0.tar.gz
Algorithm Hash digest
SHA256 41f688193bf550ceed1d8375284620c43ff04d2deb0fdf66c3c73c1bdd989548
MD5 e3e70696c0ba4f971d97e35355ffd519
BLAKE2b-256 8e3731d426813c2999b89b78e881a71eeae0a571cf61b336db45bc07710706a0

See more details on using hashes here.

File details

Details for the file abstractnn-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: abstractnn-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 47.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for abstractnn-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e104f52665b07433f7cb8d1007b209b5bb0649a96fa4d6ece9349c3c4b5b771d
MD5 fe65347481e55e3106d58da00d15d789
BLAKE2b-256 d24a157b18572cc1798574f903e84aac5e2b45a48aa47dd0beb61d3cbd919cef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page