Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc and tests after latest loo pkg release #923

Merged
merged 1 commit into from
Feb 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions R/fit.R
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ CmdStanFit$set("public", name = "init", value = init)
#' @description The `$init_model_methods()` method compiles and initializes the
#' `log_prob`, `grad_log_prob`, `constrain_variables`, `unconstrain_variables`
#' and `unconstrain_draws` functions. These are then available as methods of
#' the fitted model object. This requires the additional `Rcpp` package,
#' the fitted model object. This requires the additional `Rcpp` package,
#' which are not required for fitting models using
#' CmdStanR.
#'
Expand Down Expand Up @@ -1483,8 +1483,9 @@ CmdStanMCMC <- R6::R6Class(
#' @param r_eff (multiple options) How to handle the `r_eff` argument for `loo()`:
#' * `TRUE` (the default) will automatically call [loo::relative_eff.array()]
#' to compute the `r_eff` argument to pass to [loo::loo.array()].
#' * `FALSE` or `NULL` will avoid computing `r_eff` (which can sometimes be slow)
#' but will result in a warning from the \pkg{loo} package.
#' * `FALSE` or `NULL` will avoid computing `r_eff` (which can sometimes be slow),
#' but the reported ESS and MCSE estimates can be over-optimistic if the
#' posterior draws are not (near) independent.
#' * If `r_eff` is anything else, that object will be passed as the `r_eff`
#' argument to [loo::loo.array()].
#' @param moment_match (logical) Whether to use a
Expand Down
5 changes: 3 additions & 2 deletions man/fit-method-loo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 19 additions & 10 deletions tests/testthat/test-fit-mcmc.R
Original file line number Diff line number Diff line change
Expand Up @@ -279,19 +279,28 @@ test_that("loo method works with moment-matching", {
# Moment-matching needs model-methods, so make sure hpp is available
mod <- cmdstan_model(testing_stan_file("loo_moment_match"), force_recompile = TRUE)
data_list <- testing_data("loo_moment_match")
fit <- mod$sample(data = data_list, chains = 1)
fit <- mod$sample(data = data_list, chains = 1, seed = 1000)

# Regular LOO should warn that some pareto-k are "too high"
expect_warning(fit$loo(),
"Some Pareto k diagnostic values are too high. See help('pareto-k-diagnostic') for details.",
fixed=TRUE)
# Regular loo should warn that some pareto-k are "too high"
expect_warning(
fit$loo(),
"Some Pareto k diagnostic values are too high.",
fixed = TRUE
)

# After moment-matching the warning should be downgraded to "slightly high"
expect_warning(fit$loo(moment_match = TRUE),
"Some Pareto k diagnostic values are slightly high. See help('pareto-k-diagnostic') for details.",
fixed=TRUE)
# In loo < 2.7.0 after moment-matching the warning should be downgraded to "slightly high"
if (utils::packageVersion("loo") < "2.7.0") {
expect_warning(
fit$loo(moment_match = TRUE),
"Some Pareto k diagnostic values are slightly high.",
fixed = TRUE
)
} else {
# But in loo >= 2.7.0 there is no "slightly high" so no warning here
expect_no_warning(fit$loo(moment_match = TRUE))
}

# After moment-matching with lower target threshold there should be no warning
# After moment-matching with lower target threshold there definitely shouldn't be a warning
expect_no_warning(fit$loo(moment_match = TRUE, k_threshold=0.4))
})

Expand Down
Loading