Docs

Documentation

These docs cover the public InvarLock GitHub repository and OSS engine. Start with installation and the first evaluation loop, then move into artifact inspection, reference material, and assurance notes as your workflow matures.

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

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.

Getting Started

Environment setup, installation, and the first evaluation loop.

Open guide

Quickstart

CLI highlights for the common workflows and the first artifact outputs.

Open guide

Compare & evaluate (BYOE)

Run baseline vs subject comparisons with pinned pairing and guard checks.

Open guide

Primary Metric Smoke

Tiny examples for ppl and accuracy paths before a larger evaluation run.

Open guide

Quickstart commands

Start with the core package, add the Hugging Face extra only when needed, then run a first baseline-vs-subject evaluation.

pip install invarlock

# Optional: only for evaluate with Hugging Face-backed models
pip install "invarlock[hf]"

INVARLOCK_ALLOW_NETWORK=1 INVARLOCK_DEDUP_TEXTS=1 invarlock evaluate \
  --baseline <BASELINE_MODEL> \
  --subject <SUBJECT_MODEL> \
  --adapter auto \
  --profile ci \
  --report-out reports/eval

Choose a path

Run the quickstart if you want to execute the CLI immediately, or inspect artifacts first if you want to understand the evidence model before running anything. Use the design-partner page only for questions about the private on-prem path.

Read quickstart

Start with the common install and first-run path.

Inspect artifacts

Review real reports before running the CLI in your own environment.

Design partners

Use this only if your question is about the private on-prem path.

Synced from public upstream

Source ref

v0.8.0 (release tag)

Source commit

9119404

Synced