boostLinear {compboost} | R Documentation |
Wrapper to boost linear models for each feature.
Description
This wrapper function automatically initializes the model by adding all numerical
features of a dataset within a linear base-learner. Categorical features are
dummy encoded and inserted using linear base-learners without intercept. After
initializing the model boostLinear
also fits as many iterations as given
by the user through iters
.
Usage
boostLinear(data, target, optimizer = OptimizerCoordinateDescent$new(),
loss, learning.rate = 0.05, iterations = 100, trace = -1,
intercept = TRUE, data.source = InMemoryData,
data.target = InMemoryData)
Arguments
data |
[data.frame ]
A data frame containing the data on which the model should be built.
|
target |
[character(1) ]
Character indicating the target variable. Note that the loss must match the
data type of the target.
|
optimizer |
[S4 Optimizer ]
Optimizer to select features. This should be an initialized S4 Optimizer object
exposed by Rcpp (for instance OptimizerCoordinateDescent$new() ).
|
loss |
[S4 Loss ]
Loss used to calculate the risk and pseudo residuals. This object must be an initialized
S4 Loss object exposed by Rcpp (for instance LossQuadratic$new() ).
|
learning.rate |
[numeric(1) ]
Learning rate which is used to shrink the parameter in each step.
|
iterations |
[integer(1) ]
Number of iterations that are trained.
|
trace |
[integer(1) ]
Integer indicating how often a trace should be printed. Specifying trace = 10 , then every
10th iteration is printed. If no trace should be printed set trace = 0 . Default is
-1 which means that we set trace at a value that 40 iterations are printed.
|
intercept |
[logical(1) ]
Internally used by BaselearnerPolynomial . This logical value indicates if
each feature should get an intercept or not (default is TRUE ).
|
data.source |
[S4 Data ]
Uninitialized S4 Data object which is used to store the data. At the moment
just in memory training is supported.
|
data.target |
[S4 Data ]
Uninitialized S4 Data object which is used to store the data. At the moment
just in memory training is supported.
|
Details
The returned object is an object of the Compboost
class which then can be
used for further analyses (see ?Compboost
for details).
Value
Usually a model of class Compboost
. This model is an R6
object
which can be used for retraining, predicting, plotting, and anything described in
?Compboost
.
Examples
mod = boostLinear(data = iris, target = "Sepal.Length", loss = LossQuadratic$new())
mod$getBaselearnerNames()
mod$getEstimatedCoef()
table(mod$getSelectedBaselearner())
mod$predict()
mod$plot("Sepal.Width_linear")
[Package
compboost version 0.1.0
Index]