6.6 mlr -> mlr3 Transition Guide

In case you have already worked with mlr, you may want to quickstart with mlr3 by looking up the specific equivalent of an element of mlr in the new version mlr3. For this, you can use the following table. This table is not complete but should give you an overview about how mlr3 is organized.

Category mlr mlr3 Note
General / Helper getCacheDir() / deleteCacheDir() Not yet implemented
configureMlr()
getMlrOptions()
createDummyFeatures() Not yet implemented mlr3pipelines
crossover()
downsample() Not yet implemented
generateCalibrationData() Not yet implemented
generateCritDifferencesData() Not yet implemented
generateLearningCurveData() Not yet implemented mlr3viz
generatePartialDependenceData() Not yet implemented mlr3viz
generateThreshVsPerfData() Not yet implemented mlr3viz
getCaretParamSet() Not used anymore
reimpute() / impute() Not yet implemented mlr3pipelines
fn() / fnr() / fp() / fpr() ???
tn() / tnr() / tp() / tpr() ???
summarizeColumns() ???
summarizeLevels() ???
Task Task mlr_tasks / Task
SurvTask TaskSurv mlr3survival
ClusterTask mlr_tasks
MultilabelTask mlr_tasks
SpatialTask Not yet implemented mlr3spatiotemporal
Example tasks (iris.task,mtcars.task) mlr_tasks$get(‘iris’) / tsk(‘iris’)
convertMLBenchObjToTask() Not yet implemented mlr3
dropFeatures() Task$select()
getTaskCosts() Not yet implemented
getTaskData() Task$data()
getTaskDesc() / getTaskDescription() Task$print()
getTaskFeatureNames() Task$feature_names
getTaskFormula() Task$formula
getTaskId() Task$id
getTaskNFeats() length(Task$feature_names)
getTaskSize() Task$nrow()
getTaskTargetNames() Task$target_names
getTaskTargets() as.data.table(Task)[,Task$feature_names,with = FALSE]
getTaskType() Task$task_type
oversample() / undersample()
Learner helpLearner() Not yet implemented
helpLearnerParam() Not yet implemented
getLearnerId() Learner$id
setLearnerId() Learner$id
getLearnerModel() Learner$model
getLearnerNote() Not used anymore
getLearnerPackages() Learner$packages
getLearnerParVals() / getLearnerParamSet() Learner$param_set
getLearnerPredictType() Learner$predict_type
getLearnerShortName() Learner$predict_type
getLearnerType() Learner$Type
setPredictType() Learner$Type
getLearnerProperties ???
getParamSet() Learner$param_set
trainLearner() Learner$train()
predictLearner() Learner$predict()
makeRLearner*() Learner
generateLearningCurveData() Not yet implemented mlr3viz
FailureModel
getFailureModelDump()
getFailureModelMsg()
isFailureModel()
makeLearner() / makeLearners() ???
Train/Predict/Resample train() Experiment$train()
predict() Experiment$predict()
performance() Experiment$score()
makeResampleDesc() Resampling mlr_resamplings
resample() resample()
ResamplePrediction ResampleResult
Aggregation / makeAggregation Not yet implemented
asROCRPrediction() Not yet implemented
ConfusionMatrix / getConfMatrix() / calculateConfusionMatrix() Not yet implemented
calculateROCMeasures() Not yet implemented
estimateRelativeOverfitting() Not yet implemented
estimateResidualVariance() Not yet implemented
getDefaultMeasure()
getMeasureProperties() ???
getPredictionResponse() / getPredictionSE() / getPredictionTruth() ???
getPredictionDump() ???
getPredictionTaskDesc() ???
getRRDump() ???
getRRPredictionList() ???
getRRPredictions() ResampleResult$prediction
getRRTaskDesc() / getRRTaskDescription() ResampleResult\(task\)print()
Benchmark benchmark() benchmark()
batchmark() / reduceBatchmarkResults() not used anymore
BenchmarkResult BenchmarkResult
convertBMRToRankMatrix() Not yet implemented
convertMLBenchObjToTask() Not yet implemented
getBMRAggrPerformances() BenchmarkResult$aggregated()
getBMRFeatSelResults() Not yet implemented mlr3filters
getBMRFilteredFeatures() Not yet implemented mlr3filters
getBMRLearners() / getBMRLearnerIds() / getBMRLearnerShortNames() BenchmarkResult$learners
getBMRMeasures() / getBMRMeasureIds() BenchmarkResult$measures
getBMRModels() BenchmarkResult\(data\)learner[[1]]$model
getBMRPerformances() BenchmarkResult\(data\)performance
getBMRTaskDescriptions() / getBMRTaskDescs() / getBMRTaskIds() BenchmarkResult$tasks
getBMRTuneResults() Not yet implemented
getBMRPredictions() Not yet implemented
friedmanTestBMR() Not yet implemented
mergeBenchmarkResults() BenchmarkResult$combine()
plotBMRBoxplots() Not yet implemented mlr3viz
plotBMRRanksAsBarChart() Not yet implemented mlr3viz
plotBMRSummary() Not yet implemented mlr3viz
plotResiduals() Not yet implemented mlr3viz
Parameter Specification ParamHelpers::makeNumericParam() ParamDbl$new() paradox
ParamHelpers::makeNumericVectorParam() ParamDbl$new() paradox
ParamHelpers::makeIntegerParam() paradox::ParamInt$new() paradox
ParamHelpers::makeIntegerVectorParam() paradox::ParamInt$new() paradox
ParamHelpers::makeDiscreteParam() paradox::ParamFct$new() paradox
ParamHelpers::makeDiscreteVectorParam() paradox::ParamFct$new() paradox
ParamHelpers::makeLogicalParam() paradox::ParamLgl$new() paradox
ParamHelpers::makeLogicalVectorParam() paradox::ParamLgl$new() paradox
Preprocessing
Feature Selection makeFeatSelControlExhaustive() Not yet implemented mlr3filters
makeFeatSelControlRandom() Not yet implemented mlr3filters
makeFeatSelControlSequential() Not yet implemented mlr3filters
makeFeatSelControlGA() Not yet implemented mlr3filters
makeFilter() Filter$new() mlr3filters
FeatSelResult Not yet implemented mlr3filters
listFilterMethods() mlr_filters mlr3filters
analyzeFeatSelResult() Not yet implemented mlr3filters
getBMRFeatSelResults() Not yet implemented mlr3filters
getBMRFilteredFeatures() Not yet implemented mlr3filters
getFeatSelResult() Not yet implemented mlr3filters
getFeatureImportance() Not yet implemented mlr3filters
getFilteredFeatures() Not yet implemented mlr3filters
makeFeatSelWrapper() Not used anymore mlr3filters
makeFilterWrapper() Not used anymore mlr3filters
getResamplingIndices() Not yet implemented
selectFeatures() Not yet implemented mlr3filters
filterFeatures() Filter$filter_*() mlr3filters
generateFilterValuesData() Filter$calculate() mlr3filters
Tuning getTuneResult() Not yet implemented mlr3tuning
getTuneResultOptPath() Not yet implemented mlr3tuning
makeTuneControl*() Tuner mlr3tuning
makeTuneMultiCritControl*() Tuner mlr3tuning
Parallelization ParallelMap::parallelStart*(), parallelMap::parallelStop() future::plan() / future
Plotting plotBMRBoxplots() Not yet implemented mlr3viz
plotBMRRanksAsBarChart() Not yet implemented mlr3viz
plotBMRSummary() Not yet implemented mlr3viz
plotCalibration() Not yet implemented mlr3viz
plotCritDifferences() Not yet implemented mlr3viz
plotFilterValues() Not yet implemented mlr3viz
plotHyperParsEffect() Not yet implemented mlr3viz
plotLearnerPrediction() Not yet implemented mlr3viz
plotLearningCurve() Not yet implemented mlr3viz
plotPartialDependence() Not yet implemented mlr3viz
plotResiduals() Not yet implemented mlr3viz
plotROCCurves() Not yet implemented mlr3viz
plotThreshVsPerf() Not yet implemented mlr3viz
plotTuneMultiCritResult() Not yet implemented mlr3viz
FDA extractFDAFPCA() Not yet implemented mlr3fda
extractFDAFourier() Not yet implemented mlr3fda
extractFDAMultiResFeatures() Not yet implemented mlr3fda
extractFDAWavelets() Not yet implemented mlr3fda