Skip to content

Document the version and summary.ungraded keys in saved results #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
avalyset wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Document the version and summary.ungraded keys in saved results #137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
Loading