| tsolver_options | R Documentation |
Every T-solver input except the data X, D and y,
as one list (the C++ SolverOptions). Pass it to a solver's
$new(X, D, y, options = ...). Each solver reads the fields it
needs and ignores the rest; the defaults are the solver-level defaults.
tsolver_options(
normalize = TRUE,
intercept = TRUE,
precentered = FALSE,
scaling_mode = c("L2", "ZSCORE"),
verbose = FALSE,
tol = .Machine$double.eps,
tie_seed = 0,
n_threads = 1,
exch_tie_alpha = 0,
exch_tie_floor = 0.5,
lambda2 = 0.1,
rho_afs = 0.3,
ncgmp_variant = c("line_search", "fully_corrective"),
tenet_aug_use_lars = FALSE,
tikhonov_validated = FALSE,
kappa_dummy = 1,
fold_dummies = FALSE,
group_penalty = c("MEAN", "CENTERING"),
cd_lambda_rel_tol = 0.001,
cd_tol_certify = 1e-10,
cd_tol_probe = 1e-08,
cd_gram_cap = 400,
cd_max_sweeps = 2000,
cd_certified_localization = TRUE
)
normalize |
Logical; scale each column of X and D to unit L2 norm (or
unit SD, see |
intercept |
Logical; center X, D and y (an intercept is fitted).
|
precentered |
Logical; the caller centered X, D and y
( |
scaling_mode |
|
verbose |
Logical; print status and diagnostics. Default |
tol |
Numerical tolerance of the solver's internal comparisons.
Default: machine epsilon. A selector sets its own tolerance on the
solvers it runs, |
tie_seed |
Seed of the solver's tie-break engine. Default 0: a fixed seed, so a solver run is reproducible also where exact ties occur; a negative value seeds from the system entropy source (nondeterministic). |
n_threads |
Thread budget of the solver's own passes over the design
(the correlation refreshes, the step-length search, the standardization).
Default 1 (serial); a whole number of at least 1. A pass splits only
above about a million entries of the design, and never inside a parallel
region of the caller. The T-Rex selectors set it from
|
exch_tie_alpha |
Exchangeable-tie band width of the greedy solvers (TOMP, TOOLS, TGP, TACGP, TMP, TNCGMP and TAFS), in units of the pairwise ranking-noise sd; 0 (default) turns it off. The path solvers ignore it. |
exch_tie_floor |
Minimum absolute correlation for exchangeable-tie candidates, in [0, 1). Default 0.5. |
lambda2 |
L2 (ridge / group-ridge) penalty weight, >= 0. Read by TENET, TENETAug and TIENETAug. Default 0.1, as inside the selectors. With 0 there is no quadratic penalty and the elastic nets reduce to their lasso. |
rho_afs |
TAFS shrinkage step in (0, 1]. Default 0.3, as inside the selectors; 1 is forward stepwise. |
ncgmp_variant |
TNCGMP variant: |
tenet_aug_use_lars |
Logical; TENETAug and TIENETAug run the
augmented system with a pure-LARS inner path that never drops variables
(default |
tikhonov_validated |
Logical; TIKNET and TCDTIKNET. |
kappa_dummy |
Ridge weight of the dummy block of TCDENET, and of
TCDTIKNET with |
fold_dummies |
Logical; TCDTIKNET dummy coupling. Default
|
group_penalty |
TCDIENET structured penalty, |
cd_lambda_rel_tol, cd_tol_certify, cd_tol_probe, cd_gram_cap, cd_max_sweeps, cd_certified_localization |
Knobs of the coordinate-descent solver family; the defaults are the
solver defaults (1e-3, 1e-10, 1e-8, 400, 2000, |
A named list suitable for the options argument of every
T-solver constructor.
The T-solvers work on the caller's matrices without copying, in R as in
C++ and Python. With normalize = TRUE or intercept = TRUE a
solver is a writer: it centers / scales the columns of X and D in
place (visible on the caller's matrix or memory-mapped file), keeps the
statistics itself, and holds a claim on both until $restore() or
garbage collection, both of which write X and D back; a second writer
(T-solver or T-Rex selector) on a claimed matrix is an error, because a
second in-place transformation moves the data by rounding. With
normalize = FALSE and intercept = FALSE a solver is a
reader that runs as constructed and never writes; a pipeline with
several solvers on one matrix pre-scales once in front (MLLpNormScaler)
and constructs readers. y is never written. See TSolver_Base.
Other T-solvers:
TACGP_Solver,
TAFS_Solver,
TCDENET_Solver,
TCDIENET_Solver,
TCDLASSO_Solver,
TCDTIKNET_Solver,
TENETAug_Solver,
TENET_Solver,
TGP_Solver,
TIENETAug_Solver,
TIENET_Solver,
TIKNET_Solver,
TLARS_Solver,
TLASSO_Solver,
TMP_Solver,
TNCGMP_Solver,
TOMP_Solver,
TOOLS_Solver,
TSTAGEWISE_Solver,
TSTEPWISE_Solver
tsolver_options()
tsolver_options(lambda2 = 0.5, normalize = FALSE)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.