Update check_hmc_diagnostic function #29
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes a small bug in the
check_hmc_diagnosticsfunction where the number of iterations exceeding the treedepth was calculated asmax_treedepths <- sum(draws_df$treedepth__ > max_treedepth)but should be
max_treedepths <- sum(draws_df$treedepth__ >= max_treedepth)The sampler will never exceed the max_treedepth so perhaps
==would be more sensible. Furthermore it adds a newprint=TRUEargument to toggle console printing, and instead of returning nothing it returns a data.frame containing the percent divergences, number of treedepth exceedences, and EBMFI info. These two are useful for users running a lot of models and wanting an easy way to track this diagnostic information. I would suggest exporting this function as well, as a user may want to rerun it (e.g., in a saved session).Reprex:
results in
whereas previously it printed no warnings.
This PR is backwards compatible and passes tests locally.