From 2bbfbbf84d40db2a8369e177342915585f4f57f1 Mon Sep 17 00:00:00 2001 From: Steve Bronder Date: Thu, 18 Apr 2024 13:17:37 -0400 Subject: [PATCH] update docs for inits --- man-roxygen/model-common-args.R | 3 ++- man/model-method-diagnose.Rd | 3 ++- man/model-method-laplace.Rd | 3 ++- man/model-method-optimize.Rd | 3 ++- man/model-method-pathfinder.Rd | 3 ++- man/model-method-sample.Rd | 3 ++- man/model-method-sample_mpi.Rd | 3 ++- man/model-method-variational.Rd | 3 ++- 8 files changed, 16 insertions(+), 8 deletions(-) diff --git a/man-roxygen/model-common-args.R b/man-roxygen/model-common-args.R index 5c284d5b..248bc4b6 100644 --- a/man-roxygen/model-common-args.R +++ b/man-roxygen/model-common-args.R @@ -59,7 +59,8 @@ #' 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`] fit objects. +#' 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 diff --git a/man/model-method-diagnose.Rd b/man/model-method-diagnose.Rd index 093c3a9d..171faf32 100644 --- a/man/model-method-diagnose.Rd +++ b/man/model-method-diagnose.Rd @@ -76,7 +76,8 @@ set to \code{TRUE} (default), then resampling without replacement with Pareto smoothed weights will be used. If \code{psis_resample} was set to \code{TRUE} or \code{calculate_lp} was set to \code{FALSE} then sampling without replacement with uniform weights will be used to select the draws. -PSIS resampling is used to select the draws for \code{\link{CmdStanVB}} fit objects. +PSIS resampling is used to select the draws for \code{\link{CmdStanVB}}, +and \code{\link{CmdStanLaplace}} fit objects. \item A type inheriting from \code{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 diff --git a/man/model-method-laplace.Rd b/man/model-method-laplace.Rd index ec7b13b5..346f7706 100644 --- a/man/model-method-laplace.Rd +++ b/man/model-method-laplace.Rd @@ -89,7 +89,8 @@ set to \code{TRUE} (default), then resampling without replacement with Pareto smoothed weights will be used. If \code{psis_resample} was set to \code{TRUE} or \code{calculate_lp} was set to \code{FALSE} then sampling without replacement with uniform weights will be used to select the draws. -PSIS resampling is used to select the draws for \code{\link{CmdStanVB}} fit objects. +PSIS resampling is used to select the draws for \code{\link{CmdStanVB}}, +and \code{\link{CmdStanLaplace}} fit objects. \item A type inheriting from \code{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 diff --git a/man/model-method-optimize.Rd b/man/model-method-optimize.Rd index 0d8d9731..36a9d2cf 100644 --- a/man/model-method-optimize.Rd +++ b/man/model-method-optimize.Rd @@ -95,7 +95,8 @@ set to \code{TRUE} (default), then resampling without replacement with Pareto smoothed weights will be used. If \code{psis_resample} was set to \code{TRUE} or \code{calculate_lp} was set to \code{FALSE} then sampling without replacement with uniform weights will be used to select the draws. -PSIS resampling is used to select the draws for \code{\link{CmdStanVB}} fit objects. +PSIS resampling is used to select the draws for \code{\link{CmdStanVB}}, +and \code{\link{CmdStanLaplace}} fit objects. \item A type inheriting from \code{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 diff --git a/man/model-method-pathfinder.Rd b/man/model-method-pathfinder.Rd index 606c8953..107697ef 100644 --- a/man/model-method-pathfinder.Rd +++ b/man/model-method-pathfinder.Rd @@ -100,7 +100,8 @@ set to \code{TRUE} (default), then resampling without replacement with Pareto smoothed weights will be used. If \code{psis_resample} was set to \code{TRUE} or \code{calculate_lp} was set to \code{FALSE} then sampling without replacement with uniform weights will be used to select the draws. -PSIS resampling is used to select the draws for \code{\link{CmdStanVB}} fit objects. +PSIS resampling is used to select the draws for \code{\link{CmdStanVB}}, +and \code{\link{CmdStanLaplace}} fit objects. \item A type inheriting from \code{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 diff --git a/man/model-method-sample.Rd b/man/model-method-sample.Rd index ec2a6f82..f9fa47f7 100644 --- a/man/model-method-sample.Rd +++ b/man/model-method-sample.Rd @@ -113,7 +113,8 @@ set to \code{TRUE} (default), then resampling without replacement with Pareto smoothed weights will be used. If \code{psis_resample} was set to \code{TRUE} or \code{calculate_lp} was set to \code{FALSE} then sampling without replacement with uniform weights will be used to select the draws. -PSIS resampling is used to select the draws for \code{\link{CmdStanVB}} fit objects. +PSIS resampling is used to select the draws for \code{\link{CmdStanVB}}, +and \code{\link{CmdStanLaplace}} fit objects. \item A type inheriting from \code{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 diff --git a/man/model-method-sample_mpi.Rd b/man/model-method-sample_mpi.Rd index 77586a1c..47844a60 100644 --- a/man/model-method-sample_mpi.Rd +++ b/man/model-method-sample_mpi.Rd @@ -112,7 +112,8 @@ set to \code{TRUE} (default), then resampling without replacement with Pareto smoothed weights will be used. If \code{psis_resample} was set to \code{TRUE} or \code{calculate_lp} was set to \code{FALSE} then sampling without replacement with uniform weights will be used to select the draws. -PSIS resampling is used to select the draws for \code{\link{CmdStanVB}} fit objects. +PSIS resampling is used to select the draws for \code{\link{CmdStanVB}}, +and \code{\link{CmdStanLaplace}} fit objects. \item A type inheriting from \code{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 diff --git a/man/model-method-variational.Rd b/man/model-method-variational.Rd index 665fd9ae..6a22205a 100644 --- a/man/model-method-variational.Rd +++ b/man/model-method-variational.Rd @@ -96,7 +96,8 @@ set to \code{TRUE} (default), then resampling without replacement with Pareto smoothed weights will be used. If \code{psis_resample} was set to \code{TRUE} or \code{calculate_lp} was set to \code{FALSE} then sampling without replacement with uniform weights will be used to select the draws. -PSIS resampling is used to select the draws for \code{\link{CmdStanVB}} fit objects. +PSIS resampling is used to select the draws for \code{\link{CmdStanVB}}, +and \code{\link{CmdStanLaplace}} fit objects. \item A type inheriting from \code{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