Quick Start
Concepts
Session
A session groups related runs together, identified by a name string. Using--session model-upgrade again continues the same session—runs are linked by matching session names.
Run
A run is a single execution of your evaluations. Each run creates a new JSON file containing only the evals that ran in that execution.Auto-Generated Names
When you don’t specify--session or --run-name, friendly adjective-noun names are generated automatically:
swift-falconbright-flamegentle-whisper
File Naming
Run files are named with the pattern{run_name}_{timestamp}.json:
JSON Schema
Each run file includes session metadata at the top level:UI Display
The stats bar shows the current session and run:Use Cases
Model Comparison
Model Comparison
Compare performance across different models or configurations:Each run’s JSON file contains the full results for that model, all grouped under the same session.
Iterative Development
Iterative Development
Track progress while debugging or improving:
CI/CD Integration
CI/CD Integration
Use session names to track runs across deployments:
A/B Testing
A/B Testing
Compare different approaches:
API Endpoints
When running in serve mode, these endpoints are available for programmatic access:Example: List Sessions
Example: List Runs in Session
Best Practices
Naming Conventions: Use descriptive session names that indicate the purpose (e.g.,
model-comparison, bug-fix-123, release-v2.0). Run names should describe what’s different about that specific run.
