bebi103.hmc.decode_warning_code

bebi103.hmc.decode_warning_code(warning_code, quiet=False, return_dict=False)

Parse a binary diagnostic warning code from check_all_diagnostics() into individual failures and print the results.

Parameters:

• warning_code (int) –

  Integer whose binary representation summarizes the diagnostic output, with one bit per check. A bit set to one indicates that the corresponding check triggered a warning. The bit ordering, from least to most significant, is:

  • bit 0: divergence

  • bit 1: treedepth

  • bit 2: E-FMI

  • bit 3: average acceptance proxy

  • bit 4: tail xi_hat

  • bit 5: zero variance

  • bit 6: split Rhat

  • bit 7: incremental tau_hat

  • bit 8: minimum ess_hat

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

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

Returns:

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

Return type:

dict

Notes