From 1a040bd4bf29ce61d57e065bbfbb2d211f2dae57 Mon Sep 17 00:00:00 2001 From: jgabry Date: Wed, 20 Nov 2024 11:07:04 -0700 Subject: [PATCH] Mention vignette section on faster model saving for large models --- R/fit.R | 4 ++++ man/fit-method-save_object.Rd | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/R/fit.R b/R/fit.R index 0f76b4d02..7c4f554f8 100644 --- a/R/fit.R +++ b/R/fit.R @@ -108,6 +108,10 @@ CmdStanFit <- R6::R6Class( #' read into R lazily (i.e., as needed), the `$save_object()` method is the #' safest way to guarantee that everything has been read in before saving. #' +#' See the "Saving fitted model objects" section of the +#' [_Getting started with CmdStanR_](https://mc-stan.org/cmdstanr/articles/cmdstanr.html) +#' vignette for some suggestions on faster model saving for large models. +#' #' @param file (string) Path where the file should be saved. #' @param ... Other arguments to pass to [base::saveRDS()] besides `object` and `file`. #' diff --git a/man/fit-method-save_object.Rd b/man/fit-method-save_object.Rd index 4a019bd91..d2c2ff343 100644 --- a/man/fit-method-save_object.Rd +++ b/man/fit-method-save_object.Rd @@ -18,6 +18,10 @@ that all posterior draws and diagnostics are saved when saving a fitted model object. Because the contents of the CmdStan output CSV files are only read into R lazily (i.e., as needed), the \verb{$save_object()} method is the safest way to guarantee that everything has been read in before saving. + +See the "Saving fitted model objects" sections of the +\href{https://mc-stan.org/cmdstanr/articles/cmdstanr.html}{\emph{Getting started with CmdStanR}} +vignette for some suggestions on faster model saving for large models. } \examples{ \dontrun{