google / trax

Trax — Deep Learning with Clear Code and Speed
Apache License 2.0
8.07k stars 813 forks source link

tighten test_monte_carlo_bias_is_zero bound #1727

Open austereantelope opened 2 years ago

austereantelope commented 2 years ago

The test test_monte_carlo_bias_is_zero in advantages_test.py has an assertion bound (np.testing.assert_allclose(bias, 0, atol=0.1)) that is too loose. This means potential bug in the code could still pass the original test.

To quantify this I conducted some experiments where I generated multiple mutations of the source code under test and ran each mutant and the original code 100 times to build a distribution of their outputs. Each mutant is generated using simple mutation operators (e.g. > can become < ) on source code covered by the test. I used KS-test to find mutants that produced a different distribution from the original and use those mutants as a proxy for bugs that could be introduced. In the graph below I show the distribution of both the original code and also the mutants with a different distribution.

Here we see that the bound of 0.1 is too loose since the original distribution (in orange) is less than 0.1. Furthermore in this graph we can observe that there are many mutants (proxy for bugs) that are below the bound as well and that is undesirable since the test should aim to catch potential bugs in code. I quantify the "bug detection" of this assertion by varying the bound in a trade-off graph below.

In this graph, I plot the mutant catch rate (ratio of mutant outputs that fail the test) and the original pass rate (ratio of original output that pass the test). The original bound of 0.1 (red dotted line) has a catch rate of 0.015.

To improve this test, I propose to tighten the bound to 0.04 (the blue dotted line). The new bound has a catch rate of 0.45 (+0.44 increase compare to original) while still has >99 % pass rate (test is not flaky, I ran the updated test 500 times and observed 100 % pass rate). I think this is a good balance between improving the bug-detection ability of the test while keep the flakiness of the test low.

Do you guys think this makes sense? Please let me know if this looks good or if you have any other suggestions or questions.

My Environment:

python=3.7.11
tensorflow=2.7.0

my trax Experiment SHA: d6cae2067dedd0490b78d831033607357e975015