nvalchemi.training.distillation.evaluation.AcceptanceCheck#
- class nvalchemi.training.distillation.evaluation.AcceptanceCheck(name, value, limit, comparison, passed, detail='')[source]#
One threshold applied to one measurement.
- Parameters:
name (str)
value (float | None)
limit (float | None)
comparison (Literal['<=', '>='])
passed (bool)
detail (str)
- name#
Row label of the check: the bar’s
checkname, or"from_scratch_ratio"for the baseline bar. It can differ from the field read, asextensivity_error_per_atomreadsmax_error_per_atom.- Type:
str
- value#
Measured value, or
Nonewhen the measurement is missing. Thedivergencerow reports1.0when the stability series stopped on a divergence and0.0when it never did, against a limit of0.0.- Type:
float | None
- limit#
Bar the value was compared against.
- Type:
float | None
- comparison#
Direction the check passes in.
- Type:
{“<=”, “>=”}
- passed#
Whether the student cleared the bar.
- Type:
bool
- detail#
Why a check failed, when the reason is not the number itself.
- Type:
str