From ae0596de1f114acd339ac20bc00704ffcdbce2a9 Mon Sep 17 00:00:00 2001 From: Eirik Botten Nicolaysen Date: Tue, 3 Nov 2026 17:36:52 +0100 Subject: [PATCH] Document the version and summary.ungraded keys of the saved JSON The README described the ungraded count but not that save() writes it, nor the top-level version key. A reader of the file now finds both next to the paragraph that already explains passed, failed, errors and ungraded. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0fbe3c5..a24aa45 100644 --- a/README.md +++ b/README.md @@ -1300,6 +1300,8 @@ results.plot(save_path="./my_audit_results/audit_chart.png") `passed + failed + errors + ungraded` is the total. `ERROR` and `ungraded` results are not failures, because the model was never graded, and they are also left out of `score`. +Files written by `save()` have a top-level `version`, currently `"1.0"`, which is bumped when the serialized shape changes. Their `summary` includes an `ungraded` count alongside `passed`, `failed` and `errors`. + ### Severity Levels | Level | Score | Meaning |