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 check name, or "from_scratch_ratio" for the baseline bar. It can differ from the field read, as extensivity_error_per_atom reads max_error_per_atom.

Type:

str

value#

Measured value, or None when the measurement is missing. The divergence row reports 1.0 when the stability series stopped on a divergence and 0.0 when it never did, against a limit of 0.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

to_dict()[source]#

Return every field as a plain dictionary.

Return type:

dict[str, Any]