6.5 mlr -> mlr3 Transition Guide

In case you have already worked with mlr, you may want 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
getCacheDir() / deleteCacheDir() Not yet implemented
configureMlr()
getMlrOptions() mlr_control()
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
impute() Not yet implemented mlr3pipelines
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’)
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() Task$truth()
getTaskType() Task$task_type
Learner helpLearner() Not yet implemented
helpLearnerParam() Not yet implemented
getLearnerId() 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
getParamSet() Learner$param_set
generateLearningCurveData() Not yet implemented mlr3viz
FailureModel
getFailureModelDump()
getFailureModelMsg()
isFailureModel()
Train/Predict/Resample train() Learner$train()
predict() Learner$predict()
performance() Prediction$score()
makeResampleDesc() Resampling, mlr_resamplings
resample() resample()
Aggregation / makeAggregation Not yet implemented
asROCRPrediction() Not yet implemented
getConfMatrix() / calculateConfusionMatrix() Prediction$confusion
calculateROCMeasures() Not yet implemented
estimateRelativeOverfitting() Not yet implemented
estimateResidualVariance() Not yet implemented
getDefaultMeasure()
Benchmark benchmark() benchmark()
batchmark() / reduceBatchmarkResults() not used anymore
BenchmarkResult BenchmarkResult
convertBMRToRankMatrix() Not yet implemented
convertMLBenchObjToTask() Not yet implemented
getBMRAggrPerformances() BenchmarkResult$aggregate()
getBMRFeatSelResults() Not yet implemented mlr3featsel
getBMRFilteredFeatures() Not yet implemented mlr3featsel
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
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 mlr3featsel
makeFeatSelControlRandom() Not yet implemented mlr3featsel
makeFeatSelControlSequential() Not yet implemented mlr3featsel
makeFeatSelControlGA() Not yet implemented mlr3featsel
makeFilter() Filter$new() mlr3featsel
FeatSelResult Not yet implemented mlr3featsel
listFilterMethods() mlr_filters mlr3featsel
analyzeFeatSelResult() Not yet implemented mlr3featsel
getBMRFeatSelResults() Not yet implemented mlr3featsel
getBMRFilteredFeatures() Not yet implemented mlr3featsel
getFeatSelResult() Not yet implemented mlr3featsel
getFeatureImportance() Not yet implemented mlr3featsel
getFilteredFeatures() Not yet implemented mlr3featsel
makeFeatSelWrapper() Not used anymore mlr3featsel
makeFilterWrapper() Not used anymore mlr3featsel
getResamplingIndices() Not yet implemented
selectFeatures() Not yet implemented mlr3featsel
filterFeatures() Filter$filter_*() mlr3featsel
generateFilterValuesData() Filter$calculate() mlr3featsel
Tuning getTuneResult() AutoTuner\(learner[[1]]\)tune_path mlr3tuning
getTuneResultOptPath() Not yet implemented 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