From 2917e72ec0cbd9cd8ade6465cf44cfaf7c457461 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul-Christian=20B=C3=BCrkner?= Date: Wed, 17 Jul 2024 17:08:27 +0200 Subject: [PATCH] add pathfinder algorithm to docs --- R/brm.R | 3 ++- man/brm.Rd | 3 ++- man/brm_multiple.Rd | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/R/brm.R b/R/brm.R index 6115debf4..360296318 100644 --- a/R/brm.R +++ b/R/brm.R @@ -163,7 +163,8 @@ #' Options are \code{"sampling"} for MCMC (the default), \code{"meanfield"} for #' variational inference with independent normal distributions, #' \code{"fullrank"} for variational inference with a multivariate normal -#' distribution, or \code{"fixed_param"} for sampling from fixed parameter +#' distribution, \code{"pathfinder"} for the pathfinder algorithm, +#' or \code{"fixed_param"} for sampling from fixed parameter #' values. Can be set globally for the current \R session via the #' \code{"brms.algorithm"} option (see \code{\link{options}}). #' @param backend Character string naming the package to use as the backend for diff --git a/man/brm.Rd b/man/brm.Rd index c26c31a55..86ff43222 100644 --- a/man/brm.Rd +++ b/man/brm.Rd @@ -233,7 +233,8 @@ section below. For a comprehensive overview see Options are \code{"sampling"} for MCMC (the default), \code{"meanfield"} for variational inference with independent normal distributions, \code{"fullrank"} for variational inference with a multivariate normal -distribution, or \code{"fixed_param"} for sampling from fixed parameter +distribution, \code{"pathfinder"} for the pathfinder algorithm, +or \code{"fixed_param"} for sampling from fixed parameter values. Can be set globally for the current \R session via the \code{"brms.algorithm"} option (see \code{\link{options}}).} diff --git a/man/brm_multiple.Rd b/man/brm_multiple.Rd index abebdc083..938cc1391 100644 --- a/man/brm_multiple.Rd +++ b/man/brm_multiple.Rd @@ -142,7 +142,8 @@ the \code{\link[brms:update.brmsfit_multiple]{update}} method, instead.} Options are \code{"sampling"} for MCMC (the default), \code{"meanfield"} for variational inference with independent normal distributions, \code{"fullrank"} for variational inference with a multivariate normal -distribution, or \code{"fixed_param"} for sampling from fixed parameter +distribution, \code{"pathfinder"} for the pathfinder algorithm, +or \code{"fixed_param"} for sampling from fixed parameter values. Can be set globally for the current \R session via the \code{"brms.algorithm"} option (see \code{\link{options}}).}