Module app 

The CLI frontend for benchmark applications built with this crate.

App provides a clap-based command line interface that handles input parsing, benchmark dispatch, and regression checking. Consumers build a binary by registering Inputs and Benchmarks, then forwarding to App::parse and App::run.

Subcommands

Standard Workflow

• inputs [NAME]: List available input kinds, or describe one by name.
• benchmarks: List registered benchmarks and their descriptions.
• skeleton: Print a skeleton input JSON file.
• run --input-file <FILE> --output-file <FILE> [--dry-run]: Run benchmarks.

Regression Checks

These are accessed via check <SUBCOMMAND>:

• check skeleton: Print a skeleton tolerance JSON file.
• check tolerances [NAME]: List tolerance kinds, or describe one by name.
• check verify --tolerances <FILE> --input-file <FILE>: Validate a tolerance file against an input file.
• check run --tolerances <FILE> --input-file <FILE> --before <FILE> --after <FILE> [--output-file <FILE>]: Run regression checks.

Example

A typical binary using this crate:

use diskann_benchmark_runner::{App, registry};

fn main() -> anyhow::Result<()> {
    let mut inputs = registry::Inputs::new();
    // inputs.register::<MyInput>()?;

    let mut benchmarks = registry::Benchmarks::new();
    // benchmarks.register::<MyBenchmark>("my-bench");
    // benchmarks.register_regression::<MyRegressionBenchmark>("my-regression");

    let app = App::parse();
    let mut output = diskann_benchmark_runner::output::default();
    app.run(&inputs, &benchmarks, &mut output)
}

Regression Workflow

1. Run benchmarks twice (e.g. before and after a code change) with run, producing two output files.
2. Author a tolerance file describing acceptable variation (use check skeleton and check tolerances for guidance).
3. Validate the tolerance file with check verify.
4. Compare the two output files with check run.

Structs

App

The CLI used to drive a benchmark application.

Enums

Check

Subcommands for regression check operations.

Commands

Parsed command line options.