Skip to contents

MsArd: ARD engine specification

Source: R/engines-ard.R
MsArd.Rd

[MsArd] is the concrete [MsEngine] spec for automatic-relevance- determination NMF extraction (U-M2-04; SignatureAnalyzer semantics: KL likelihood with an ARD prior on component precisions, automatic rank pruning). Build one with [ms_ard()]. Violations raise `msuiter_error_engine`.

Usage

MsArd(
  name = "ard",
  mode = "extract",
  params = list(),
  deterministic = TRUE,
  packages = character(0),
  label = "ARD-NMF (SignatureAnalyzer semantics)",
  a0 = 10,
  b0 = 5,
  tol = 1e-05,
  max_iter = 2000,
  seed = 1
)

Arguments

name

registry key; fixed to `"ard"`.

mode

spec mode; fixed to `"extract"`.

params

named list of hyper-parameters (empty: the ARD hyper-parameters live in the dedicated properties below).

deterministic

always TRUE: the kernel is seeded and deterministic.

packages

character vector of required R packages; none.

label

human-readable engine label.

a0

ARD prior shape (upstream default 10).

b0

ARD prior rate (upstream default 5).

tol

convergence tolerance on the max relative beta change (upstream default 1e-5).

max_iter

single positive whole number of update iterations.

seed

single whole number in `[0, 2^31 - 1]` seeding the in-house PCG64 stream of the initializer.