eradiate.testing.regression.RegressionTestOutcome#
- class eradiate.testing.regression.RegressionTestOutcome(passed, metric_name, metric_value, threshold, variable, details=NOTHING, warnings=NOTHING, diagnostic_data=NOTHING)#
Bases:
objectVerdict of a single
RegressionTest.evaluate()call, together with everything a caller needs to report it.- Parameters:
passed (
bool) –Trueiff the test passed.metric_name (
str) – Name of the test metric.metric_value (
floatorNone) – Value of the test metric,Noneif it could not be computed.threshold (
float) – Threshold the metric was compared with.variable (
str) – Name of the tested data variable.details (
dict, default:{}) – Intermediate quantities that document the decision, rendered as report lines by the caller.warnings (
listofstr, default:[]) – Messages the caller should surface as warnings, e.g. about degraded reference data.diagnostic_data (
dict, default:{}) – Data consumed byRegressionTest.plot_diagnostic()to draw the diagnostic panel of the comparison chart. Empty when the test has no diagnostic.
- Fields:
passed (
bool) –Trueiff the test passed.metric_name (
str) – Name of the test metric.metric_value (
floatorNone) – Value of the test metric,Noneif it could not be computed.threshold (
float) – Threshold the metric was compared with.variable (
str) – Name of the tested data variable.details (
dict) – Intermediate quantities that document the decision, rendered as report lines by the caller.warnings (
listofstr) – Messages the caller should surface as warnings, e.g. about degraded reference data.diagnostic_data (
dict) – Data consumed byRegressionTest.plot_diagnostic()to draw the diagnostic panel of the comparison chart.