xlab-adapters(7)

NAME

xlab-adapters — define how a sample is taken and independently verified.

SYNOPSIS

xlab adapters
xlab init ~/labs/compression --example compression

DESCRIPTION

Adapter	Measurement	Verification
command	Shell command wall time, CPU, RSS; optional self-reported metrics	Untimed after hook
compression	Compression/decompression time, CPU, RSS, ratio, throughput	Round trip against the corpus digest
simulated	Known effects with controlled noise, drift, and voids	Synthetic reference for the lab
manual	A person or instrument supplies values later	Declared protocol and recorded result

Command. Separate setup and verification from timing. A failed process or failed verification raises a void; its timing never becomes a measurement.

Compression. Install the codecs named in the spec. Preflight checks exact command lines and inputs before measuring. The smoke spec checks the harness, not which compressor is best.

Simulated. Use for learning and testing the statistics. Do not present its known effects as findings about a real system.

Manual. The runner opens tasks and keeps working on other runs. Export instructions with xlab tasks --csv, enter values, and import the completed CSV.

Agent (planned). The agent adapter, isolated workspaces, graders, token accounting, and agent-specific fingerprints have not shipped. A command that launches an agent does not provide these guarantees by itself.

EXAMPLES

xlab preflight experiments/C0-smoke.toml
xlab tasks --csv
xlab import RUN completed.csv

Custom adapters subclass Adapter, return numeric metrics, and raise Void with a reason. Load a lab's adapters/*.py or declare importable modules under [lab] adapters. See the adapter docstrings and root README for the hooks.

SEE ALSO

Corpora · Record · CLI reference