LearnerAuditorFitter {mcboost}R Documentation

Create an AuditorFitter from a Learner

Description

Instantiates an AuditorFitter that trains a mlr3::Learner on the data.

Value

AuditorFitter

list with items

Functions

Super class

mcboost::AuditorFitter -> LearnerAuditorFitter

Public fields

learner

LearnerPredictor
Learner used for fitting residuals.

Methods

Public methods

Inherited methods

Method new()

Define an AuditorFitter from a Learner. Available instantiations:
TreeAuditorFitter (rpart) and RidgeAuditorFitter (glmnet).

Usage
LearnerAuditorFitter$new(learner)
Arguments
learner

mlr3::Learner
Regression learner to use.


Method fit()

Fit the learner and compute correlation

Usage
LearnerAuditorFitter$fit(data, resid, mask)
Arguments
data

data.table
Features.

resid

numeric
Residuals (of same length as data).

mask

integer
Mask applied to the data. Only used for SubgroupAuditorFitter.


Method clone()

The objects of this class are cloneable with this method.

Usage
LearnerAuditorFitter$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

mcboost::AuditorFitter -> mcboost::LearnerAuditorFitter -> TreeAuditorFitter

Methods

Public methods

Inherited methods

Method new()

Define a AuditorFitter from a rpart learner.

Usage
TreeAuditorFitter$new()

Method clone()

The objects of this class are cloneable with this method.

Usage
TreeAuditorFitter$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

mcboost::AuditorFitter -> mcboost::LearnerAuditorFitter -> RidgeAuditorFitter

Methods

Public methods

Inherited methods

Method new()

Define a AuditorFitter from a glmnet learner.

Usage
RidgeAuditorFitter$new()

Method clone()

The objects of this class are cloneable with this method.

Usage
RidgeAuditorFitter$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

Other AuditorFitter: CVLearnerAuditorFitter, SubgroupAuditorFitter, SubpopAuditorFitter

Other AuditorFitter: CVLearnerAuditorFitter, SubgroupAuditorFitter, SubpopAuditorFitter

Other AuditorFitter: CVLearnerAuditorFitter, SubgroupAuditorFitter, SubpopAuditorFitter


[Package mcboost version 0.4.3 Index]