Documentation

These docs describe the current closed release-regression transaction: evaluate a pinned baseline and subject over one schedule, independently verify the signed evidence, render the authenticated comparison, and optionally hand the technical result to current recipient policy. Evaluator qualification supplies a separate, evaluator-neutral path into authenticated per-record import.

If you want to discuss the private deployment offering that is being refined with design partners, use the design-partners page instead of treating these OSS docs as product packaging.

Follow the authority, not only the commands

Each step produces a named artifact and hands authority to a different role. Select a step to see what changes and who may assert it.

01—06

Close request

Bind both artifacts, one schedule, one metric, policy, runtime, and output.

Artifact

request.yaml

Authority

Evaluation operator

Start here

Follow the same onboarding path as the upstream README: install the package, run a first evaluation, then move into baseline-vs-subject workflows and evidence review.

01

Getting Started

Complete the first evaluate, verify, and report transaction.

Open guide

02

Evaluation Request

Close the artifacts, dataset, runtime, metric, policy, mode, and destination.

Open guide

03

Evidence & Verification

Publish signed evidence and replay it against independent trust anchors.

Open guide

04

Evaluator Qualification

Normalize open or proprietary evaluator output and preserve its authority boundary.

Open guide

05

Recipient Acceptance

Transport one signed technical result and apply current recipient policy.

Open guide

Primary commands

Install the core, add Hugging Face execution dependencies when needed, then use one request and one evidence directory across the transaction.

pip install invarlock

# Optional: only for evaluate with Hugging Face-backed models
pip install "invarlock[hf]"
invarlock evaluate request.yaml
invarlock verify evidence/ --trust-profile trust.json
invarlock report evidence/

Choose a path

Run the getting-started transaction if you want to execute the CLI, or inspect the trust and artifact references first if you own release approval. Use the design-partner page only for private deployment workflow questions.

Read getting started

Follow the complete evaluate, verify, and report path.

Inspect qualified evidence

See public bundles, signed receipts, suite conditions, and missing-evidence states.

Design partners

Use this only if your question is about the private deployment path.

Synced from public upstream

Source ref

v0.14.0 (release tag)

Source commit

57521e3

Synced

Jul 28, 2026

Docs / visuals

39 docs, 21 site visuals

11 upstream diagram replacements

Artifact Trail

Start here to see what the evaluation operator publishes, what the technical verifier replays, which receipt carries the technical result, and how a recipient applies current acceptance policy.

Evidence Artifacts

Map every canonical bundle path to the claim and binding it carries.

Reports & Receipts

Read the canonical comparison and separately signed technical receipt.

Acceptance Handoff

Transport one receipt, bind the exact artifact, and apply current recipient policy.

Trust Model

Understand evidence, receipt, envelope, recipient, renderer, and residual trust.

User Guide

12

Closed requests, runtime execution, signed evidence, independent verification, CI, and public qualification.

Assurance

6

Decision semantics, pairing, reproducibility, technical-verdict limits, and the scoped assurance case.

Reference

16

Exact CLI, evaluator, acceptance, compatibility, contract, artifact, report, provider, and embedding interfaces.

Security

4

Trust roles, threat boundaries, key handling, dependency audit, and operational hardening.