Repository navigation
Commit 683028b
committed
docs: fix kl_divergence and chi_square audit arguments and semantics
The documented examples used argument names that the built-in audits do not
accept, so copying them fails with "Macro variable 'source_column' is undefined":
- kl_divergence takes source_column / target_column (not column / target_column)
- chi_square takes column_a / column_b (not column / target_column)
The chi_square description also said the audit ensures the statistic does not
exceed the critical value. The implementation does the opposite by default:
with dependent := true (the default) it asserts that the columns are dependent
and fails when the statistic does not exceed the critical value. Document the
dependent argument and both behaviours, and fix the "statistic0" typo.
Also align the kl_divergence usage comment in builtin.py with its arguments.
Signed-off-by: shinichitazawa <shinichitazawa.aws@gmail.com>1 parent d69c262 commit 683028b
2 files changed
Lines changed: 7 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
664 | 664 | | |
665 | 665 | | |
666 | 666 | | |
667 | | - | |
| 667 | + | |
668 | 668 | | |
669 | 669 | | |
670 | 670 | | |
671 | 671 | | |
672 | 672 | | |
673 | | - | |
| 673 | + | |
| 674 | + | |
| 675 | + | |
674 | 676 | | |
675 | 677 | | |
676 | 678 | | |
| |||
680 | 682 | | |
681 | 683 | | |
682 | 684 | | |
683 | | - | |
| 685 | + | |
684 | 686 | | |
685 | 687 | | |
686 | 688 | | |
687 | 689 | | |
688 | | - | |
| 690 | + | |
689 | 691 | | |
690 | 692 | | |
691 | 693 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
524 | 524 | | |
525 | 525 | | |
526 | 526 | | |
527 | | - | |
| 527 | + | |
528 | 528 | | |
529 | 529 | | |
530 | 530 | | |
| |||
0 commit comments