karenina.benchmark.core.results_store¶
results_store
¶
Standalone results store for accumulating verification results across runs.
ResultsStore holds VerificationResultSets keyed by run name, providing query, filter, summary, and export capabilities independent of the Benchmark facade.
Classes¶
ResultsStore
¶
Accumulates VerificationResultSets keyed by run name.
Each call to add() stores a full result set under a unique run name.
Query methods allow filtering by run, question, or recency. The store is
independent of the Benchmark facade and can be composed with it or used
on its own.
Example
Source code in src/karenina/benchmark/core/results_store.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | |
Functions¶
__init__
¶
add
¶
add(
result_set: VerificationResultSet,
run_name: str | None = None,
) -> str
Add a result set to the store.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
result_set
¶ |
VerificationResultSet
|
The verification result set to store. |
required |
run_name
¶ |
str | None
|
Key for this run. If None, a timestamped name is
generated automatically ( |
None
|
Returns:
| Type | Description |
|---|---|
str
|
The run name under which the result set was stored. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If |
Source code in src/karenina/benchmark/core/results_store.py
clear
¶
clear(
question_ids: list[str] | None = None,
run_name: str | None = None,
) -> int
Remove results from the store.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
question_ids
¶ |
list[str] | None
|
If provided, remove only results with these
question IDs (from all runs, or from |
None
|
run_name
¶ |
str | None
|
If provided, scope the clear to this run only. |
None
|
Returns:
| Type | Description |
|---|---|
int
|
Number of individual results removed. |
Source code in src/karenina/benchmark/core/results_store.py
export
¶
export(
question_ids: list[str] | None = None,
run_name: str | None = None,
) -> dict[str, Any]
Export results as a JSON-serializable dict.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
question_ids
¶ |
list[str] | None
|
If provided, include only results with these question IDs. |
None
|
run_name
¶ |
str | None
|
If provided, include only this run. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Dict with a |
dict[str, Any]
|
serialized result dicts. If any scenario execution results |
dict[str, Any]
|
carry |
dict[str, Any]
|
added at the top level mapping run name to a dict of |
dict[str, Any]
|
|
Source code in src/karenina/benchmark/core/results_store.py
export_to_file
¶
Write exported results to a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file_path
¶ |
str | Path
|
Destination path for the JSON file. |
required |
**kwargs
¶ |
Any
|
Passed through to |
{}
|
Source code in src/karenina/benchmark/core/results_store.py
from_file
classmethod
¶
from_file(file_path: str | Path) -> ResultsStore
Load a ResultsStore from a previously exported JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file_path
¶ |
str | Path
|
Path to the JSON file. |
required |
Returns:
| Type | Description |
|---|---|
ResultsStore
|
A new ResultsStore populated with the loaded data. |
Raises:
| Type | Description |
|---|---|
FileNotFoundError
|
If the file does not exist. |
ValueError
|
If the file content is not valid. |
Source code in src/karenina/benchmark/core/results_store.py
get_all_runs
¶
Return run names in insertion order.
Returns:
| Type | Description |
|---|---|
list[str]
|
List of run name strings. |
get_by_question
¶
get_by_question(
question_id: str,
) -> dict[str, list[VerificationResult]]
Collect results for a question across all runs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
question_id
¶ |
str
|
The question ID to search for. |
required |
Returns:
| Type | Description |
|---|---|
dict[str, list[VerificationResult]]
|
Dict mapping run name to a list of matching VerificationResult |
dict[str, list[VerificationResult]]
|
objects. Runs with no matches are omitted. |
Source code in src/karenina/benchmark/core/results_store.py
get_by_run
¶
get_by_run(run_name: str) -> VerificationResultSet
Return the result set for a given run.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
run_name
¶ |
str
|
The run to look up. |
required |
Returns:
| Type | Description |
|---|---|
VerificationResultSet
|
The VerificationResultSet stored under |
Raises:
| Type | Description |
|---|---|
KeyError
|
If the run name does not exist. |
Source code in src/karenina/benchmark/core/results_store.py
get_latest
¶
get_latest(
question_id: str | None = None,
) -> dict[str, VerificationResult]
Return the most recent result per question.
Iterates runs in reverse insertion order and collects the first result encountered for each question ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
question_id
¶ |
str | None
|
If provided, only return the latest result for this specific question. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, VerificationResult]
|
Dict mapping question ID to the most recent VerificationResult. |
Source code in src/karenina/benchmark/core/results_store.py
get_statistics_by_run
¶
Return per-run summary statistics.
Returns:
| Type | Description |
|---|---|
dict[str, dict[str, Any]]
|
Dict mapping each run name to its summary dict |
dict[str, dict[str, Any]]
|
(same shape as |
Source code in src/karenina/benchmark/core/results_store.py
get_summary
¶
get_summary(run_name: str | None = None) -> dict[str, Any]
Return aggregate statistics across stored results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
run_name
¶ |
str | None
|
If provided, scope statistics to this run. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Dict with keys: total_results, total_runs, unique_questions, |
dict[str, Any]
|
completed_count, failed_count, success_rate. |
Source code in src/karenina/benchmark/core/results_store.py
has_results
¶
has_results(
question_id: str | None = None,
run_name: str | None = None,
) -> bool
Check whether results exist, optionally filtered.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
question_id
¶ |
str | None
|
If provided, check only for this question. |
None
|
run_name
¶ |
str | None
|
If provided, check only in this run. |
None
|
Returns:
| Type | Description |
|---|---|
bool
|
True if at least one matching result exists. |