Sweeper Quickstart

<!— Generated from aisimulate/docs/sweeper/quickstart.md by docs/fern/scripts/sync_aisimulate_docs.py. Edit the canonical source instead of this Fern copy. —>

From a source checkout, install AI Simulate and run its neutral example:

$
python -m pip install -e ./aisimulate
$
python aisimulate/examples/sweeper/run_sweep.py \
>
  --config aisimulate/examples/sweeper/sweep.yaml

The example runner returns deterministic metrics so you can inspect orchestration without importing an application framework. A production composition supplies a RunnerFactory that executes real replay:

1
from aisimulate.sweeper import SmartSearchConfig, Sweeper
2
3
config = SmartSearchConfig.from_yaml("sweep.yaml")
4
sweeper = Sweeper(runner_factory=my_runner_factory, show_progress=False)
5
candidates = sweeper.run(config)

Set sweep.parallel_evals above one to use spawned worker processes. Scripts using that mode must guard their entrypoint with if __name__ == "__main__":.

Next, read the Tutorial for the complete configuration flow or Sweep Configuration Providers to add feature-specific search dimensions.