Skip to content

Commit 33b021f

Browse files
committed
Document GPU plan assertion callback
Signed-off-by: Allen Xu <allxu@nvidia.com>
1 parent 1fae4bb commit 33b021f

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

integration_tests/src/main/python/asserts.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,16 @@ def assert_cpu_and_gpu_are_equal_collect_with_capture(func,
505505
conf={},
506506
require_non_empty=False,
507507
gpu_plan_assertion=None):
508+
"""Compare collected CPU/GPU results and validate the executed GPU plan.
509+
510+
:param func: Function that creates the dataframe to collect in each Spark session.
511+
:param exist_classes: Comma-separated class names required in the GPU plan.
512+
:param non_exist_classes: Comma-separated class names forbidden in the GPU plan.
513+
:param conf: Spark configuration used for both executions.
514+
:param require_non_empty: Require the collected CPU result to contain at least one row.
515+
:param gpu_plan_assertion: Optional callback invoked after GPU collection with the
516+
dataframe's executed JVM plan.
517+
"""
508518
(bring_back, collect_type) = _prep_func_for_compare(func, 'COLLECT_WITH_DATAFRAME')
509519

510520
conf = _prep_incompat_conf(conf)

0 commit comments

Comments
 (0)