API reference

AxoBench evaluation CLI

Complete options and defaults for axosim-evaluate-model.

Usage

axosim-evaluate-model --help

Every command and subcommand accepts -h or --help. The option reference below includes exact parser defaults, choices, required arguments, and compatibility options hidden from ordinary help.

--baseline-cache and --baseline-checkpoint are mutually exclusive. --output and the compatibility alias --output-json are mutually exclusive. --save-cache cannot be combined with either baseline comparison path. The current AxoBench package is required for execution.

axosim-evaluate-model

Parameters

checkpoint str · required
Upstream baseline checkpoint file.
--baseline-checkpoint str · default=None
Second checkpoint evaluated on the same traces as the paired baseline.
--baseline-cache str · default=None
Baseline cache written by --save-cache; its protocol, trace IDs, and target hash must match.
--save-cache str · default=None
Write this model's predictions and protocol as a reusable .npz baseline cache.
--dataset-root str · required
AxoBench evaluation root containing val/ and optionally interventions/<condition>/.
--model-id str · default=None
Model name in the report; defaults to the checkpoint file stem.
--device str · default='auto'
Execution or allocation device.
--batch-size int · default=128
Examples processed per batch.
--max-samples int · default=None
Validation traces to select; AxoBench defaults to 120.
--max-intervention-samples int · default=None
Pairs per intervention condition; AxoBench defaults to 40.
--max-interventions int · default=8
Maximum number of intervention conditions read in sorted order.
--intervention-workers int · default=4
Parallel CPU loaders for intervention shards.
--interventions str · default=None
comma-separated intervention names; default discovers all
--multiple-morphologies flag · default=False
balance the 120/40 evaluation profile across available morphologies Sets multiple_morphologies=True.
--morphology-id str · default=None
specific morphology for the default single-morphology evaluation
--ignore-start int · default=500
Initial native timesteps excluded by the declared path.
--calibration-fraction float · default=0.25
Share of the selected traces used only to calibrate the spike threshold.
--default-spike-threshold float · default=0.0
Uncalibrated threshold checked by the default_threshold_count diagnostic; it does not set the scoring threshold.
--bootstrap-replicates int · default=250
Replicates of the morphology-stratified paired bootstrap.
--bootstrap-seed int · default=20260711
Random seed of the paired bootstrap.
--output str · default=None
optional .json or .csv report path
--output-json str · default=None
Compatibility option hidden from default help.

Parser source

Search guides, examples, and API signatures.