Skip to content

recommend() docs: name pin's actual consumers #43

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.

Sign up for GitHub

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

Merged
TroyHernandez merged 1 commit into from
Jul 22, 2026
Merged

recommend() docs: name pin's actual consumers #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions R/recommend.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,12 @@
#' memory pressure into OOM kills. \code{pin} is TRUE when available
#' host RAM covers the model's pinned set twice over, FALSE below that,
#' FALSE on the cpu tier (nothing stages), and TRUE when RAM cannot be
#' detected (page-locking already fails soft per component). Loaders
#' honor it through their \code{pin} arguments and
#' \code{options(diffuseR.pin_staging)}.
#' detected (page-locking already fails soft per component). Today the
#' LTX pipeline and Gemma3 encoder loaders take \code{pin} arguments
#' and stage pinned weights (see \code{\link{staging_ltx23}}); the
#' image-model loaders do not stage weights yet, so for them \code{pin}
#' is forward-looking policy with no consumer.
#' \code{options(diffuseR.pin_staging)} is the global switch.
#'
#' @param model "sd21", "sdxl", "flux1", "flux2", "zimage", or "ltx".
#' @param vram_gb Numeric or NULL. Free VRAM in GB; auto-detected via
Expand Down
9 changes: 6 additions & 3 deletions man/recommend.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,12 @@ but pinned pages are unswappable, so on small-RAM machines they turn
memory pressure into OOM kills. \code{pin} is TRUE when available
host RAM covers the model's pinned set twice over, FALSE below that,
FALSE on the cpu tier (nothing stages), and TRUE when RAM cannot be
detected (page-locking already fails soft per component). Loaders
honor it through their \code{pin} arguments and
\code{options(diffuseR.pin_staging)}.
detected (page-locking already fails soft per component). Today the
LTX pipeline and Gemma3 encoder loaders take \code{pin} arguments
and stage pinned weights (see \code{\link{staging_ltx23}}); the
image-model loaders do not stage weights yet, so for them \code{pin}
is forward-looking policy with no consumer.
\code{options(diffuseR.pin_staging)} is the global switch.

}
\examples{
Expand Down
Loading