Skip to main content

Edit‑agnostic robustness evaluation reports for weight edits (InvarLock framework)

Project description

InvarLock

Edit‑agnostic robustness reports for weight edits

CI PyPI Docs License: Apache-2.0 Python 3.12+

Catch silent quality regressions from quantization, pruning, and weight edits before they ship.

Quantizing, pruning, or otherwise editing a model’s weights can silently degrade quality. InvarLock compares an edited subject checkpoint against a fixed baseline with paired evaluation windows, enforces a guard pipeline (invariants → spectral → RMT → variance), and produces a machine‑readable Evaluation Report you can gate in CI.

Why InvarLock?

  • Quality gates for weight edits: catch regressions before deployment.
  • Statistical guarantees: paired primary metrics with confidence intervals.
  • Auditable evidence: deterministic pairing metadata + policy digests in evaluation.report.json.
  • CI/CD-friendly: stable exit codes, --json outputs, and portable “proof packs”.
  • Offline-first: network is disabled by default; enable downloads per command.

Who is this for?

  • ML engineers shipping quantized/pruned checkpoints.
  • MLOps teams building CI quality gates and reviewable artifacts.
  • Researchers validating compression/edit methods with reproducible, paired eval.

How it works

┌───────────────────────┐     ┌────────────────────────────────────────────┐
│ Baseline (checkpoint) │────►│                                            │
└───────────────────────┘     │  invarlock evaluate                        │
                              │  ├─► Paired windows (deterministic)        │
┌───────────────────────┐     │  ├─► GuardChain pipeline                   │
│ Subject  (checkpoint) │────►│  │   └─► invariants → spectral → RMT → VE  │
└───────────────────────┘     │  └─► Emit: evaluation.report.json          │    
                              │                                            │
                              └────────────────────────────────────────────┘                                                                                               
                                                     │                                                                                                                          
                                     ┌───────────────┴───────────────┐                                                                                                          
                                     ▼                               ▼                                                                                                          
                                 ✅ PASS                          ❌ FAIL                                                                                                        
                                 (ship)                          (rollback)    
                                     

Quick start

Colab (CPU-friendly): Open in Colab

# HF adapter stack (torch/transformers)
pip install "invarlock[hf]"

# Version + report schema (when available)
invarlock --version

# Compare baseline vs subject (downloads require explicit network enable)
INVARLOCK_ALLOW_NETWORK=1 invarlock evaluate \
  --baseline gpt2 \
  --subject  gpt2 \
  --adapter auto \
  --profile dev \
  --quiet

# Validate the evaluation report
invarlock verify reports/eval/evaluation.report.json

# Render HTML for sharing
invarlock report html -i reports/eval/evaluation.report.json -o reports/eval/evaluation.html

Example output (abridged; counts vary by profile/config):

INVARLOCK v<version> · EVALUATE
Baseline: gpt2 -> Subject: gpt2 · Profile: dev
Status: PASS · Gates: <passed>/<total> passed
Primary metric ratio: <ratio>
Output: reports/eval/evaluation.report.json

Proof packs (portable evidence bundles)

Proof packs bundle reports + verification metadata into a distributable artifact.

Note: configs/ and scripts/ are repo resources and are not shipped in wheels; clone the repo to use presets and proof-pack helpers.

Installation

# Minimal CLI (no torch/transformers)
pip install invarlock

# HF workflows (torch/transformers)
pip install "invarlock[hf]"

Optional extras: invarlock[gpu], invarlock[awq,gptq]. Full setup: https://github.com/invarlock/invarlock/blob/main/docs/user-guide/getting-started.md.

Documentation

Community

Citation

If you use InvarLock in scientific work, please cite it (canonical metadata is in CITATION.cff):

@software{invarlock,
  title  = {InvarLock: Edit-agnostic robustness evaluation reports for weight edits},
  author = {{InvarLock Maintainers}},
  url    = {https://github.com/invarlock/invarlock},
}

Limitations

  • InvarLock evaluates an edited model relative to a baseline under a specific configuration; results are not “global” guarantees.
  • Not a content-safety/alignment tool.
  • Native Windows is not supported (use WSL2 or Linux).

Support matrix

Platform Status Notes
Python 3.12+ ✅ Required
Linux ✅ Full Primary dev target
macOS (Intel/M-series) ✅ Full MPS supported (default on Apple Silicon)
Windows ❌ Not supported Use WSL2 or a Linux container if required
CUDA ✅ Recommended For larger models
CPU ✅ Fallback Slower but functional

Project status

InvarLock is pre‑1.0. Until 1.0, minor releases may include breaking changes. See CHANGELOG.md.

For guidance on where to ask questions, how to report bugs, and what to expect in terms of response times, see SUPPORT.md.

Contributing

License

Apache-2.0 — see 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

invarlock-0.3.11.tar.gz (486.7 kB view details)

Uploaded Source

Built Distribution

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

invarlock-0.3.11-py3-none-any.whl (539.7 kB view details)

Uploaded Python 3

File details

Details for the file invarlock-0.3.11.tar.gz.

File metadata

  • Download URL: invarlock-0.3.11.tar.gz
  • Upload date:
  • Size: 486.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for invarlock-0.3.11.tar.gz
Algorithm Hash digest
SHA256 ed46b1aaa5fdd008e3eb06e582b9e2ac74c9324f792adfc38addab72f0e89fec
MD5 4803b4d4259e86eb9a86454dae26d34d
BLAKE2b-256 904edfd99ef416596d435b2cafa2e0cd09e281df1b13cf52bff4adc9be96aee4

See more details on using hashes here.

Provenance

The following attestation bundles were made for invarlock-0.3.11.tar.gz:

Publisher: release.yml on invarlock/invarlock

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

File details

Details for the file invarlock-0.3.11-py3-none-any.whl.

File metadata

  • Download URL: invarlock-0.3.11-py3-none-any.whl
  • Upload date:
  • Size: 539.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for invarlock-0.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 eb524902aa8e9a464da6fcfca2cbf40b440f7daf58a2655f1b4cd0b3dafdc0a1
MD5 6afcedcd0230662da08909804256fbb5
BLAKE2b-256 8f21ef117f20927f1e95005743fd09a648edccaf9c01a1906f3b2edffe5dbc85

See more details on using hashes here.

Provenance

The following attestation bundles were made for invarlock-0.3.11-py3-none-any.whl:

Publisher: release.yml on invarlock/invarlock

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

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