model-method-sample: Run Stan's MCMC algorithms
In stan-dev/cmdstanr: R Interface to 'CmdStan'

model-method-sample

R Documentation

Run Stan's MCMC algorithms

Description

The ⁠$sample()⁠ method of a CmdStanModel object runs Stan's main Markov chain Monte Carlo algorithm.

Any argument left as NULL will default to the default value used by the installed version of CmdStan. See the CmdStan User’s Guide for more details.

After model fitting any diagnostics specified via the diagnostics argument will be checked and warnings will be printed if warranted.

Usage

sample(
  data = NULL,
  seed = NULL,
  refresh = NULL,
  init = NULL,
  save_latent_dynamics = FALSE,
  output_dir = getOption("cmdstanr_output_dir"),
  output_basename = NULL,
  sig_figs = NULL,
  chains = 4,
  parallel_chains = getOption("mc.cores", 1),
  chain_ids = seq_len(chains),
  threads_per_chain = NULL,
  opencl_ids = NULL,
  iter_warmup = NULL,
  iter_sampling = NULL,
  save_warmup = FALSE,
  thin = NULL,
  max_treedepth = NULL,
  adapt_engaged = TRUE,
  adapt_delta = NULL,
  step_size = NULL,
  metric = NULL,
  metric_file = NULL,
  inv_metric = NULL,
  init_buffer = NULL,
  term_buffer = NULL,
  window = NULL,
  fixed_param = FALSE,
  show_messages = TRUE,
  show_exceptions = TRUE,
  diagnostics = c("divergences", "treedepth", "ebfmi"),
  save_metric = NULL,
  save_cmdstan_config = NULL,
  cores = NULL,
  num_cores = NULL,
  num_chains = NULL,
  num_warmup = NULL,
  num_samples = NULL,
  validate_csv = NULL,
  save_extra_diagnostics = NULL,
  max_depth = NULL,
  stepsize = NULL
)

Arguments

`data`	(multiple options) The data to use for the variables specified in the data block of the Stan program. One of the following: A named list of R objects with the names corresponding to variables declared in the data block of the Stan program. Internally this list is then written to JSON for CmdStan using `write_stan_json()`. See `write_stan_json()` for details on the conversions performed on R objects before they are passed to Stan. A path to a data file compatible with CmdStan (JSON or R dump). See the appendices in the CmdStan guide for details on using these formats. `NULL` or an empty list if the Stan program has no data block.
`seed`	(positive integer(s)) A seed for the (P)RNG to pass to CmdStan. In the case of multi-chain sampling the single `seed` will automatically be augmented by the the run (chain) ID so that each chain uses a different seed. The exception is the transformed data block, which defaults to using same seed for all chains so that the same data is generated for all chains if RNG functions are used. The only time `seed` should be specified as a vector (one element per chain) is if RNG functions are used in transformed data and the goal is to generate different data for each chain.
`refresh`	(non-negative integer) The number of iterations between printed screen updates. If `refresh = 0`, only error messages will be printed.
`init`	(multiple options) The initialization method to use for the variables declared in the parameters block of the Stan program. One of the following: A real number `x>0`. This initializes all parameters randomly between `⁠[-x,x]⁠` on the unconstrained parameter space.; The number `0`. This initializes all parameters to `0`; A character vector of paths (one per chain) to JSON or Rdump files containing initial values for all or some parameters. See `write_stan_json()` to write R objects to JSON files compatible with CmdStan. A list of lists containing initial values for all or some parameters. For MCMC the list should contain a sublist for each chain. For other model fitting methods there should be just one sublist. The sublists should have named elements corresponding to the parameters for which you are specifying initial values. See Examples. A function that returns a single list with names corresponding to the parameters for which you are specifying initial values. The function can take no arguments or a single argument `chain_id`. For MCMC, if the function has argument `chain_id` it will be supplied with the chain id (from 1 to number of chains) when called to generate the initial values. See Examples. A `CmdStanMCMC`, `CmdStanMLE`, `CmdStanVB`, `CmdStanPathfinder`, or `CmdStanLaplace` fit object. If the fit object's parameters are only a subset of the model parameters then the other parameters will be drawn by Stan's default initialization. The fit object must have at least some parameters that are the same name and dimensions as the current Stan model. For the `sample` and `pathfinder` method, if the fit object has fewer draws than the requested number of chains/paths then the inits will be drawn using sampling with replacement. Otherwise sampling without replacement will be used. When a `CmdStanPathfinder` fit object is used as the init, if . `psis_resample` was set to `FALSE` and `calculate_lp` was set to `TRUE` (default), then resampling without replacement with Pareto smoothed weights will be used. If `psis_resample` was set to `TRUE` or `calculate_lp` was set to `FALSE` then sampling without replacement with uniform weights will be used to select the draws. PSIS resampling is used to select the draws for `CmdStanVB`, and `CmdStanLaplace` fit objects. A type inheriting from `posterior::draws`. If the draws object has less samples than the number of requested chains/paths then the inits will be drawn using sampling with replacement. Otherwise sampling without replacement will be used. If the draws object's parameters are only a subset of the model parameters then the other parameters will be drawn by Stan's default initialization. The fit object must have at least some parameters that are the same name and dimensions as the current Stan model.
`save_latent_dynamics`	(logical) Should auxiliary diagnostic information about the latent dynamics be written to temporary diagnostic CSV files? This argument replaces CmdStan's `diagnostic_file` argument and the content written to CSV is controlled by the user's CmdStan installation and not CmdStanR (for some algorithms no content may be written). The default is `FALSE`, which is appropriate for almost every use case. To save the temporary files created when `save_latent_dynamics=TRUE` see the `$save_latent_dynamics_files()` method.
`output_dir`	(string) A path to a directory where CmdStan should write its output CSV files. For MCMC there will be one file per chain; for other methods there will be a single file. For interactive use this can typically be left at `NULL` (temporary directory) since CmdStanR makes the CmdStan output (posterior draws and diagnostics) available in R via methods of the fitted model objects. This can be set for an entire R session using `options(cmdstanr_output_dir)`. The behavior of `output_dir` is as follows: If `NULL` (the default), then the CSV files are written to a temporary directory and only saved permanently if the user calls one of the `⁠$save_*⁠` methods of the fitted model object (e.g., `$save_output_files()`). These temporary files are removed when the fitted model object is garbage collected (manually or automatically). If a path, then the files are created in `output_dir` with names corresponding to the defaults used by `⁠$save_output_files()⁠`.
`output_basename`	(string) A string to use as a prefix for the names of the output CSV files of CmdStan. If `NULL` (the default), the basename of the output CSV files will be comprised from the model name, timestamp, and 5 random characters.
`sig_figs`	(positive integer) The number of significant figures used when storing the output values. By default, CmdStan represent the output values with 6 significant figures. The upper limit for `sig_figs` is 18. Increasing this value will result in larger output CSV files and thus an increased usage of disk space.
`chains`	(positive integer) The number of Markov chains to run. The default is 4.
`parallel_chains`	(positive integer) The maximum number of MCMC chains to run in parallel. If `parallel_chains` is not specified then the default is to look for the option `"mc.cores"`, which can be set for an entire R session by `options(mc.cores=value)`. If the `"mc.cores"` option has not been set then the default is `1`.
`chain_ids`	(integer vector) A vector of chain IDs. Must contain as many unique positive integers as the number of chains. If not set, the default chain IDs are used (integers starting from `1`).
`threads_per_chain`	(positive integer) If the model was compiled with threading support, the number of threads to use in parallelized sections within an MCMC chain (e.g., when using the Stan functions `reduce_sum()` or `map_rect()`). This is in contrast with `parallel_chains`, which specifies the number of chains to run in parallel. The actual number of CPU cores used is `parallel_chains*threads_per_chain`. For an example of using threading see the Stan case study Reduce Sum: A Minimal Example.
`opencl_ids`	(integer vector of length 2) The platform and device IDs of the OpenCL device to use for fitting. The model must be compiled with `cpp_options = list(stan_opencl = TRUE)` for this argument to have an effect.
`iter_warmup`	(positive integer) The number of warmup iterations to run per chain. Note: in the CmdStan User's Guide this is referred to as `num_warmup`.
`iter_sampling`	(positive integer) The number of post-warmup iterations to run per chain. Note: in the CmdStan User's Guide this is referred to as `num_samples`.
`save_warmup`	(logical) Should warmup iterations be saved? The default is `FALSE`.
`thin`	(positive integer) The period between saved samples. This should typically be left at its default (no thinning) unless memory is a problem.
`max_treedepth`	(positive integer) The maximum allowed tree depth for the NUTS engine. See the Tree Depth section of the CmdStan User's Guide for more details.
`adapt_engaged`	(logical) Do warmup adaptation? The default is `TRUE`. If a precomputed inverse metric is specified via the `inv_metric` argument (or `metric_file`) then, if `adapt_engaged=TRUE`, Stan will use the provided inverse metric just as an initial guess during adaptation. To turn off adaptation when using a precomputed inverse metric set `adapt_engaged=FALSE`.
`adapt_delta`	(real in `⁠(0,1)⁠`) The adaptation target acceptance statistic.
`step_size`	(positive real) The initial step size for the discrete approximation to continuous Hamiltonian dynamics. This is further tuned during warmup.
`metric`	(string) One of `"diag_e"`, `"dense_e"`, or `"unit_e"`, specifying the geometry of the base manifold. See the Euclidean Metric section of the CmdStan User's Guide for more details. To specify a precomputed (inverse) metric, see the `inv_metric` argument below.
`metric_file`	(character vector) The paths to JSON or Rdump files (one per chain) compatible with CmdStan that contain precomputed inverse metrics. The `metric_file` argument is inherited from CmdStan but is confusing in that the entry in JSON or Rdump file(s) must be named `inv_metric`, referring to the inverse metric. We recommend instead using CmdStanR's `inv_metric` argument (see below) to specify an inverse metric directly using a vector or matrix from your R session.
`inv_metric`	(vector, matrix) A vector (if `metric='diag_e'`) or a matrix (if `metric='dense_e'`) for initializing the inverse metric. This can be used as an alternative to the `metric_file` argument. A vector is interpreted as a diagonal metric. The inverse metric is usually set to an estimate of the posterior covariance. See the `adapt_engaged` argument above for details about (and control over) how specifying a precomputed inverse metric interacts with adaptation.
`init_buffer`	(nonnegative integer) Width of initial fast timestep adaptation interval during warmup.
`term_buffer`	(nonnegative integer) Width of final fast timestep adaptation interval during warmup.
`window`	(nonnegative integer) Initial width of slow timestep/metric adaptation interval.
`fixed_param`	(logical) When `TRUE`, call CmdStan with argument `"algorithm=fixed_param"`. The default is `FALSE`. The fixed parameter sampler generates a new sample without changing the current state of the Markov chain; only generated quantities may change. This can be useful when, for example, trying to generate pseudo-data using the generated quantities block. If the parameters block is empty then using `fixed_param=TRUE` is mandatory. When `fixed_param=TRUE` the `chains` and `parallel_chains` arguments will be set to `1`.
`show_messages`	(logical) When `TRUE` (the default), prints all output during the execution process, such as iteration numbers and elapsed times. If the output is silenced then the `$output()` method of the resulting fit object can be used to display the silenced messages.
`show_exceptions`	(logical) When `TRUE` (the default), prints all informational messages, for example rejection of the current proposal. Disable if you wish to silence these messages, but this is not usually recommended unless you are very confident that the model is correct up to numerical error. If the messages are silenced then the `$output()` method of the resulting fit object can be used to display the silenced messages.
`diagnostics`	(character vector) The diagnostics to automatically check and warn about after sampling. Setting this to an empty string `""` or `NULL` can be used to prevent CmdStanR from automatically reading in the sampler diagnostics from CSV if you wish to manually read in the results and validate them yourself, for example using `read_cmdstan_csv()`. The currently available diagnostics are `"divergences"`, `"treedepth"`, and `"ebfmi"` (the default is to check all of them). These diagnostics are also available after fitting. The `$sampler_diagnostics()` method provides access the diagnostic values for each iteration and the `$diagnostic_summary()` method provides summaries of the diagnostics and can regenerate the warning messages. Diagnostics like R-hat and effective sample size are not currently available via the `diagnostics` argument but can be checked after fitting using the `$summary()` method.
`save_metric`	(logical) When `TRUE`, call CmdStan with argument `"adaptation save_metric=1"` to save the adapted metric in separate JSON file with elements "stepsize", "metric_type" and "inv_metric". The default is `TRUE`. This option is only available in CmdStan 2.34.0 and later.
`save_cmdstan_config`	(logical) When `TRUE` (the default), call CmdStan with argument `"output save_config=1"` to save a json file which contains the argument tree and extra information (equivalent to the output CSV file header). This option is only available in CmdStan 2.34.0 and later.
`cores`, `num_cores`, `num_chains`, `num_warmup`, `num_samples`, `save_extra_diagnostics`, `max_depth`, `stepsize`, `validate_csv`	Deprecated and will be removed in a future release.

Value

A CmdStanMCMC object.

Examples

## Not run: 
library(cmdstanr)
library(posterior)
library(bayesplot)
color_scheme_set("brightblue")

# Set path to CmdStan
# (Note: if you installed CmdStan via install_cmdstan() with default settings
# then setting the path is unnecessary but the default below should still work.
# Otherwise use the `path` argument to specify the location of your
# CmdStan installation.)
set_cmdstan_path(path = NULL)

# Create a CmdStanModel object from a Stan program,
# here using the example model that comes with CmdStan
file <- file.path(cmdstan_path(), "examples/bernoulli/bernoulli.stan")
mod <- cmdstan_model(file)
mod$print()
# Print with line numbers. This can be set globally using the
# `cmdstanr_print_line_numbers` option.
mod$print(line_numbers = TRUE)

# Data as a named list (like RStan)
stan_data <- list(N = 10, y = c(0,1,0,0,0,0,0,0,0,1))

# Run MCMC using the 'sample' method
fit_mcmc <- mod$sample(
  data = stan_data,
  seed = 123,
  chains = 2,
  parallel_chains = 2
)

# Use 'posterior' package for summaries
fit_mcmc$summary()

# Check sampling diagnostics
fit_mcmc$diagnostic_summary()

# Get posterior draws
draws <- fit_mcmc$draws()
print(draws)

# Convert to data frame using posterior::as_draws_df
as_draws_df(draws)

# Plot posterior using bayesplot (ggplot2)
mcmc_hist(fit_mcmc$draws("theta"))

# Run 'optimize' method to get a point estimate (default is Stan's LBFGS algorithm)
# and also demonstrate specifying data as a path to a file instead of a list
my_data_file <- file.path(cmdstan_path(), "examples/bernoulli/bernoulli.data.json")
fit_optim <- mod$optimize(data = my_data_file, seed = 123)
fit_optim$summary()

# Run 'optimize' again with 'jacobian=TRUE' and then draw from Laplace approximation
# to the posterior
fit_optim <- mod$optimize(data = my_data_file, jacobian = TRUE)
fit_laplace <- mod$laplace(data = my_data_file, mode = fit_optim, draws = 2000)
fit_laplace$summary()

# Run 'variational' method to use ADVI to approximate posterior
fit_vb <- mod$variational(data = stan_data, seed = 123)
fit_vb$summary()
mcmc_hist(fit_vb$draws("theta"))

# Run 'pathfinder' method, a new alternative to the variational method
fit_pf <- mod$pathfinder(data = stan_data, seed = 123)
fit_pf$summary()
mcmc_hist(fit_pf$draws("theta"))

# Run 'pathfinder' again with more paths, fewer draws per path,
# better covariance approximation, and fewer LBFGSs iterations
fit_pf <- mod$pathfinder(data = stan_data, num_paths=10, single_path_draws=40,
                         history_size=50, max_lbfgs_iters=100)

# Specifying initial values as a function
fit_mcmc_w_init_fun <- mod$sample(
  data = stan_data,
  seed = 123,
  chains = 2,
  refresh = 0,
  init = function() list(theta = runif(1))
)
fit_mcmc_w_init_fun_2 <- mod$sample(
  data = stan_data,
  seed = 123,
  chains = 2,
  refresh = 0,
  init = function(chain_id) {
    # silly but demonstrates optional use of chain_id
    list(theta = 1 / (chain_id + 1))
  }
)
fit_mcmc_w_init_fun_2$init()

# Specifying initial values as a list of lists
fit_mcmc_w_init_list <- mod$sample(
  data = stan_data,
  seed = 123,
  chains = 2,
  refresh = 0,
  init = list(
    list(theta = 0.75), # chain 1
    list(theta = 0.25)  # chain 2
  )
)
fit_optim_w_init_list <- mod$optimize(
  data = stan_data,
  seed = 123,
  init = list(
    list(theta = 0.75)
  )
)
fit_optim_w_init_list$init()

## End(Not run)

stan-dev/cmdstanr documentation built on April 12, 2025, 8:40 p.m.