Validate.get_step_report

Validate.get_step_report(i)

Get a detailed report for a single validation step.

The get_step_report() method returns a report of what went well, or what failed spectacularly, for a given validation step. The report includes a summary of the validation step and a detailed breakdown of the interrogation results. The report is presented as a GT table object, which can be displayed in a notebook or exported to an HTML file.

Warning

The get_step_report() is still experimental. Please report any issues you encounter at the Pointblank issue tracker.

Parameters

i : int

The step number for which to get a detailed report.

Returns

: GT

A GT table object that represents the detailed report for the validation step.

Examples

Let’s create a validation plan with a few validation steps and interrogate the data. With that, we’ll have a look at the validation reporting table for the entire collection of steps and what went well or what failed.

import pointblank as pb

validation = (
    pb.Validate(
        data=pb.load_dataset(dataset="small_table", tbl_type="pandas"),
        tbl_name="small_table",
        label="Example for the get_step_report() method",
        thresholds=(1, 0.20, 0.40)
    )
    .col_vals_lt(columns="d", value=3500)
    .col_vals_between(columns="c", left=1, right=8)
    .col_vals_gt(columns="a", value=3)
    .col_vals_regex(columns="b", pattern=r"\d-[a-z]{3}-\d{3}")
    .interrogate()
)

validation
STEP COLUMNS VALUES TBL EVAL UNITS PASS FAIL W S N EXT
#FFBF00 1
col_vals_lt
col_vals_lt() 		d 3500 ✓ 13 11
0.85		 2
0.15		 ● ○ ○
#CF142B 2
col_vals_between
col_vals_between() 		c [1, 8] ✓ 13 9
0.69		 4
0.31		 ● ● ○
#CF142B 3
col_vals_gt
col_vals_gt() 		a 3 ✓ 13 6
0.46		 7
0.54		 ● ● ●
#4CA64C 4
col_vals_regex
col_vals_regex() 		b \d-[a-z]{3}-\d{3} ✓ 13 13
1.00		 0
0.00		 ○ ○ ○ —

There were four validation steps performed, where the first three steps had failing test units and the last step had no failures. Let’s get a detailed report for the first step by using the get_step_report() method.

validation.get_step_report(i=1)
Report for Validation Step 1
ASSERTION d < 3500
2 / 13 TEST UNIT FAILURES IN COLUMN 6
EXTRACT OF 2 ROWS WITH TEST UNIT FAILURES IN RED:
date_time
Datetime
date
Datetime
a
Int64
b
String
c
Float64
d
Float64
e
Boolean
f
String
1 2016-01-04 00:32:00 2016-01-04 00:00:00 3 5-egh-163 8.0 9999.99 True low
2 2016-01-06 17:23:00 2016-01-06 00:00:00 2 5-jdo-903 NA 3892.4 False mid

The report for the first step is displayed. The report includes a summary of the validation step and a detailed breakdown of the interrogation results. The report provides details on what the validation step was checking, the extent to which the test units failed, and a table that shows the failing rows of the data with the column of interest highlighted.

The second and third steps also had failing test units. Reports for those steps can be viewed by using get_step_report(i=2) and get_step_report(i=3) respectively.

The final step did not have any failing test units. A report for the final step can still be viewed by using get_step_report(i=4). The report will indicate that every test unit passed and a prview of the target table will be provided.

validation.get_step_report(i=4)
Report for Validation Step 4 ✓
ASSERTION b matches regex \d-[a-z]{3}-\d{3}
13 TEST UNITS ALL PASSED IN COLUMN 4
PREVIEW OF TARGET TABLE:
date_time
Datetime
date
Datetime
a
Int64
b
String
c
Float64
d
Float64
e
Boolean
f
String
1 2016-01-04 11:00:00 2016-01-04 00:00:00 2 1-bcd-345 3.0 3423.29 True high
2 2016-01-04 00:32:00 2016-01-04 00:00:00 3 5-egh-163 8.0 9999.99 True low
3 2016-01-05 13:32:00 2016-01-05 00:00:00 6 8-kdg-938 3.0 2343.23 True high
4 2016-01-06 17:23:00 2016-01-06 00:00:00 2 5-jdo-903 NA 3892.4 False mid
5 2016-01-09 12:36:00 2016-01-09 00:00:00 8 3-ldm-038 7.0 283.94 True low
9 2016-01-20 04:30:00 2016-01-20 00:00:00 3 5-bce-642 9.0 837.93 False high
10 2016-01-20 04:30:00 2016-01-20 00:00:00 3 5-bce-642 9.0 837.93 False high
11 2016-01-26 20:07:00 2016-01-26 00:00:00 4 2-dmx-010 7.0 833.98 True low
12 2016-01-28 02:51:00 2016-01-28 00:00:00 2 7-dmx-010 8.0 108.34 False low
13 2016-01-30 11:23:00 2016-01-30 00:00:00 1 3-dka-303 NA 2230.09 True high