bebi103.stan.parse_warning_code

bebi103.stan.parse_warning_code(warning_code, quiet=False, return_dict=False)

Parses warning code from check_all_diagnostics() into individual failures and prints results.

Parameters

• warning_code (int) –

  When converted to binary, each digit in the code stands for whether or not a test passed. A digit of zero indicates the test passed. The ordering of the tests goes:

  • ESS

  • r_hat

  • divergences

  • tree depth

  • E-BFMI

  For example, a warning code of 12 has a binary representation of 01100, which means that R-hat and divergences tests failed.

• quiet (bool, default False) – If True, suppress print results to the screen.

• return_dict (bool, default False) – If True, return a dictionary of containing test passage info.

Returns

output – If return_dict is True, returns a dictionary where each entry is True is the respective diagnostic check was passed and False if it was not.

Return type

dict