Root package API¶
Primary public exports¶
| Name | Kind | Use when | Key constraints / notes |
|---|---|---|---|
| Package metadata | Category | You need package version information | Includes __version__ |
| Experiment authoring | Category | You want the main Python surfaces for authoring and executing runs | Includes Experiment, evaluate |
| Prompt authoring | Category | Prompt material should be part of experiment identity | Includes PromptSpec |
| Persistence | Category | You need concrete stores or store abstractions | Includes InMemoryRunStore, SqliteRunStore, RunStore, sqlite_store |
| Execution and results | Category | You need compiled snapshots, status, results, or runtime tuning models | Includes RunSnapshot, RunResult, RunEstimate, RunStatus, RuntimeConfig |
| Inspection and reporting | Category | You want reporting, inspection, or summary helpers | Includes Reporter, StatsEngine, get_run_snapshot, get_execution_state, get_evaluation_execution, quickcheck, snapshot_report |
| Bundle workflows | Category | You want to export or import stage artifacts | Includes generation, reduction, parse, score, and evaluation bundle helpers |
Use Experiment lifecycle for the core execution flow and Stores and inspection for reporting and persistence helpers.