# Machine Learning in R - Next Generation

## Documentation for package ‘mlr3’ version 1.3.0

- DESCRIPTION file
- Package NEWS
- Package README

## Help Pages

A B C D E F H I L M P R S T U

mlr3-package | mlr3: Machine Learning in R - Next Generation

## -- A --

assert_resample_callback | Assertions for Callbacks
assert_resample_callbacks | Assertions for Callbacks
as_benchmark_result | Convert to BenchmarkResult
as_benchmark_result.BenchmarkResult | Convert to BenchmarkResult
as_benchmark_result.ResampleResult | Convert to BenchmarkResult
as_data_backend | Create a Data Backend
as_data_backend.data.frame | Create a Data Backend
as_learner | Convert to a Learner
as_learner.Learner | Convert to a Learner
as_learners | Convert to a Learner
as_learners.default | Convert to a Learner
as_learners.list | Convert to a Learner
as_measure | Convert to a Measure
as_measure.Measure | Convert to a Measure
as_measure.NULL | Convert to a Measure
as_measures | Convert to a Measure
as_measures.default | Convert to a Measure
as_measures.list | Convert to a Measure
as_measures.NULL | Convert to a Measure
as_prediction | Convert to a Prediction
as_prediction.Prediction | Convert to a Prediction
as_prediction.PredictionDataClassif | Convert to a Prediction
as_prediction.PredictionDataRegr | Convert to a Prediction
as_predictions | Convert to a Prediction
as_predictions.list | Convert to a Prediction
as_prediction_classif | Convert to a Classification Prediction
as_prediction_classif.data.frame | Convert to a Classification Prediction
as_prediction_classif.PredictionClassif | Convert to a Classification Prediction
as_prediction_data | PredictionData
as_prediction_data.list | PredictionData
as_prediction_data.Prediction | PredictionData
as_prediction_data.PredictionData | PredictionData
as_prediction_regr | Convert to a Regression Prediction
as_prediction_regr.data.frame | Convert to a Regression Prediction
as_prediction_regr.PredictionRegr | Convert to a Regression Prediction
as_resample_result | Convert to ResampleResult
as_resample_result.list | Convert to ResampleResult
as_resample_result.ResampleResult | Convert to ResampleResult
as_resample_result.ResultData | Convert to ResampleResult
as_resampling | Convert to a Resampling
as_resampling.Resampling | Convert to a Resampling
as_resamplings | Convert to a Resampling
as_resamplings.default | Convert to a Resampling
as_resamplings.list | Convert to a Resampling
as_result_data | Convert to ResultData
as_task | Convert to a Task
as_task.Task | Convert to a Task
as_tasks | Convert to a Task
as_tasks.default | Convert to a Task
as_tasks.list | Convert to a Task
as_tasks_unsupervised | Convert to an Unsupervised Task
as_tasks_unsupervised.list | Convert to an Unsupervised Task
as_tasks_unsupervised.Task | Convert to an Unsupervised Task
as_task_classif | Convert to a Classification Task
as_task_classif.data.frame | Convert to a Classification Task
as_task_classif.DataBackend | Convert to a Classification Task
as_task_classif.formula | Convert to a Classification Task
as_task_classif.matrix | Convert to a Classification Task
as_task_classif.TaskClassif | Convert to a Classification Task
as_task_classif.TaskRegr | Convert to a Classification Task
as_task_regr | Convert to a Regression Task
as_task_regr.data.frame | Convert to a Regression Task
as_task_regr.DataBackend | Convert to a Regression Task
as_task_regr.formula | Convert to a Regression Task
as_task_regr.matrix | Convert to a Regression Task
as_task_regr.TaskClassif | Convert to a Regression Task
as_task_regr.TaskRegr | Convert to a Regression Task
as_task_unsupervised | Convert to an Unsupervised Task
as_task_unsupervised.data.frame | Convert to an Unsupervised Task
as_task_unsupervised.DataBackend | Convert to an Unsupervised Task
as_task_unsupervised.Task | Convert to an Unsupervised Task

## -- B --

benchmark | Benchmark Multiple Learners on Multiple Tasks
BenchmarkResult | Container for Benchmarking Results
benchmark_grid | Generate a Benchmark Grid Design

## -- C --

c.PredictionDataClassif | Convert to PredictionData
c.PredictionDataRegr | Convert to PredictionData
california_housing | Median House Value in California
CallbackResample | Resample Callback
callback_resample | Create Evaluation Callback
check_prediction_data | Convert to PredictionData
check_prediction_data.PredictionDataClassif | Convert to PredictionData
check_prediction_data.PredictionDataRegr | Convert to PredictionData
ContextResample | Resample Context
convert_task | Convert a Task from One Type to Another
create_empty_prediction_data | Convert to PredictionData

## -- D --

DataBackend | DataBackend
DataBackendDataTable | DataBackend for data.table
default_fallback | Create a Fallback Learner
default_fallback.Learner | Create a Fallback Learner
default_fallback.LearnerClassif | Create a Fallback Learner
default_fallback.LearnerRegr | Create a Fallback Learner
default_measures | Get the Default Measure

## -- E --

extract_pkgs | Install (Missing) Packages
extract_pkgs.BenchmarkResult | Install (Missing) Packages
extract_pkgs.character | Install (Missing) Packages
extract_pkgs.list | Install (Missing) Packages
extract_pkgs.R6 | Install (Missing) Packages
extract_pkgs.ResampleResult | Install (Missing) Packages

## -- F --

filter_prediction_data | Convert to PredictionData

## -- H --

HotstartStack | Stack for Hot Start Learners

## -- I --

install_pkgs | Install (Missing) Packages
is_marshaled_model | (Un)marshal a Learner
is_missing_prediction_data | Convert to PredictionData
is_missing_prediction_data.PredictionDataClassif | Convert to PredictionData
is_missing_prediction_data.PredictionDataRegr | Convert to PredictionData

## -- L --

Learner | Learner Class
LearnerClassif | Classification Learner
LearnerClassifDebug | Classification Learner for Debugging
LearnerClassifFeatureless | Featureless Classification Learner
LearnerClassifRpart | Classification Tree Learner
LearnerRegr | Regression Learner
LearnerRegrDebug | Regression Learner for Debugging
LearnerRegrFeatureless | Featureless Regression Learner
LearnerRegrRpart | Regression Tree Learner
learner_marshal | (Un)marshal a Learner
learner_marshaled | (Un)marshal a Learner
learner_unmarshal | (Un)marshal a Learner
lrn | Syntactic Sugar for Object Construction
lrns | Syntactic Sugar for Object Construction

## -- M --

marshaling | (Un)marshal a Learner
marshal_model | (Un)marshal a Learner
Measure | Measure Class
MeasureAIC | Akaike Information Criterion Measure
MeasureBIC | Bayesian Information Criterion Measure
MeasureClassif | Classification Measure
MeasureClassifCosts | Cost-sensitive Classification Measure
MeasureDebugClassif | Debug Measure for Classification
MeasureElapsedTime | Elapsed Time Measure
MeasureInternalValidScore | Measure Internal Validation Score
MeasureOOBError | Out-of-bag Error Measure
MeasureRegr | Regression Measure
MeasureRegrPinball | Average Pinball Loss
MeasureRegrRQR | R-Squared for Quantile Regression
MeasureRegrRSQ | R-Squared
MeasureSelectedFeatures | Selected Features Measure
MeasureSimilarity | Similarity Measure
mlr3 | mlr3: Machine Learning in R - Next Generation
mlr3.holdout_task | Callback Holdout Task
mlr3.model_extractor | Model Extractor Callback
mlr_learners | Dictionary of Learners
mlr_learners_classif.debug | Classification Learner for Debugging
mlr_learners_classif.featureless | Featureless Classification Learner
mlr_learners_classif.rpart | Classification Tree Learner
mlr_learners_regr.debug | Regression Learner for Debugging
mlr_learners_regr.featureless | Featureless Regression Learner
mlr_learners_regr.rpart | Regression Tree Learner
mlr_measures | Dictionary of Performance Measures
mlr_measures_aic | Akaike Information Criterion Measure
mlr_measures_bic | Bayesian Information Criterion Measure
mlr_measures_classif.acc | Classification Accuracy
mlr_measures_classif.auc | Area Under the ROC Curve
mlr_measures_classif.bacc | Balanced Accuracy
mlr_measures_classif.bbrier | Binary Brier Score
mlr_measures_classif.ce | Classification Error
mlr_measures_classif.costs | Cost-sensitive Classification Measure
mlr_measures_classif.dor | Diagnostic Odds Ratio
mlr_measures_classif.fbeta | F-beta Score
mlr_measures_classif.fdr | False Discovery Rate
mlr_measures_classif.fn | False Negatives
mlr_measures_classif.fnr | False Negative Rate
mlr_measures_classif.fomr | False Omission Rate
mlr_measures_classif.fp | False Positives
mlr_measures_classif.fpr | False Positive Rate
mlr_measures_classif.logloss | Log Loss
mlr_measures_classif.mauc_au1p | Multiclass AUC Scores
mlr_measures_classif.mauc_au1u | Multiclass AUC Scores
mlr_measures_classif.mauc_aunp | Multiclass AUC Scores
mlr_measures_classif.mauc_aunu | Multiclass AUC Scores
mlr_measures_classif.mauc_mu | Multiclass AUC Scores
mlr_measures_classif.mbrier | Multiclass Brier Score
mlr_measures_classif.mcc | Matthews Correlation Coefficient
mlr_measures_classif.npv | Negative Predictive Value
mlr_measures_classif.ppv | Positive Predictive Value
mlr_measures_classif.prauc | Area Under the Precision-Recall Curve
mlr_measures_classif.precision | Positive Predictive Value
mlr_measures_classif.recall | True Positive Rate
mlr_measures_classif.sensitivity | True Positive Rate
mlr_measures_classif.specificity | True Negative Rate
mlr_measures_classif.tn | True Negatives
mlr_measures_classif.tnr | True Negative Rate
mlr_measures_classif.tp | True Positives
mlr_measures_classif.tpr | True Positive Rate
mlr_measures_debug_classif | Debug Measure for Classification
mlr_measures_elapsed_time | Elapsed Time Measure
mlr_measures_internal_valid_score | Measure Internal Validation Score
mlr_measures_oob_error | Out-of-bag Error Measure
mlr_measures_regr.bias | Bias
mlr_measures_regr.ktau | Kendall's tau
mlr_measures_regr.mae | Mean Absolute Error
mlr_measures_regr.mape | Mean Absolute Percent Error
mlr_measures_regr.maxae | Max Absolute Error
mlr_measures_regr.medae | Median Absolute Error
mlr_measures_regr.medse | Median Squared Error
mlr_measures_regr.mse | Mean Squared Error
mlr_measures_regr.msle | Mean Squared Log Error
mlr_measures_regr.pbias | Percent Bias
mlr_measures_regr.pinball | Average Pinball Loss
mlr_measures_regr.rmse | Root Mean Squared Error
mlr_measures_regr.rmsle | Root Mean Squared Log Error
mlr_measures_regr.rqr | R-Squared for Quantile Regression
mlr_measures_regr.rsq | R-Squared
mlr_measures_regr.sae | Sum of Absolute Errors
mlr_measures_regr.smape | Symmetric Mean Absolute Percent Error
mlr_measures_regr.srho | Spearman's rho
mlr_measures_regr.sse | Sum of Squared Errors
mlr_measures_selected_features | Selected Features Measure
mlr_measures_sim.jaccard | Jaccard Similarity Index
mlr_measures_sim.phi | Phi Coefficient Similarity
mlr_measures_time_both | Elapsed Time Measure
mlr_measures_time_predict | Elapsed Time Measure
mlr_measures_time_train | Elapsed Time Measure
mlr_resamplings | Dictionary of Resampling Strategies
mlr_resamplings_bootstrap | Bootstrap Resampling
mlr_resamplings_custom | Custom Resampling
mlr_resamplings_custom_cv | Custom Cross-Validation
mlr_resamplings_cv | Cross-Validation Resampling
mlr_resamplings_holdout | Holdout Resampling
mlr_resamplings_insample | Insample Resampling
mlr_resamplings_loo | Leave-One-Out Cross-Validation
mlr_resamplings_repeated_cv | Repeated Cross-Validation Resampling
mlr_resamplings_subsampling | Subsampling Resampling
mlr_sugar | Syntactic Sugar for Object Construction
mlr_tasks | Dictionary of Tasks
mlr_tasks_breast_cancer | Wisconsin Breast Cancer Classification Task
mlr_tasks_california_housing | Median House Value in California
mlr_tasks_german_credit | German Credit Classification Task
mlr_tasks_iris | Iris Classification Task
mlr_tasks_mtcars | Motor Trend Regression Task
mlr_tasks_penguins | Palmer Penguins Data Set
mlr_tasks_pima | Pima Indian Diabetes Classification Task
mlr_tasks_sonar | Sonar Classification Task
mlr_tasks_spam | Spam Classification Task
mlr_tasks_wine | Wine Classification Task
mlr_tasks_zoo | Zoo Classification Task
mlr_task_generators | Dictionary of Task Generators
mlr_task_generators_2dnormals | 2D Normals Classification Task Generator
mlr_task_generators_cassini | Cassini Classification Task Generator
mlr_task_generators_circle | Circle Classification Task Generator
mlr_task_generators_friedman1 | Friedman1 Regression Task Generator
mlr_task_generators_moons | Moons Classification Task Generator
mlr_task_generators_peak | Peak Regression Task Generator
mlr_task_generators_simplex | Simplex Classification Task Generator
mlr_task_generators_smiley | Smiley Classification Task Generator
mlr_task_generators_spirals | Spiral Classification Task Generator
mlr_task_generators_xor | XOR Classification Task Generator
mlr_test_helpers | Documentation of mlr3 test helpers
msr | Syntactic Sugar for Object Construction
msrs | Syntactic Sugar for Object Construction

## -- P --

partition | Manually Partition into Training, Test and Validation Set
partition.Task | Manually Partition into Training, Test and Validation Set
predict.Learner | Predict Method for Learners
Prediction | Abstract Prediction Object
PredictionClassif | Prediction Object for Classification
PredictionData | Convert to PredictionData
PredictionRegr | Prediction Object for Regression
print.roc_measures | Print ROC Measures

## -- R --

resample | Resample a Learner on a Task
ResampleResult | Container for Results of 'resample()'
Resampling | Resampling Class
ResamplingBootstrap | Bootstrap Resampling
ResamplingCustom | Custom Resampling
ResamplingCustomCV | Custom Cross-Validation
ResamplingCV | Cross-Validation Resampling
ResamplingHoldout | Holdout Resampling
ResamplingInsample | Insample Resampling
ResamplingLOO | Leave-One-Out Cross-Validation
ResamplingRepeatedCV | Repeated Cross-Validation Resampling
ResamplingSubsampling | Subsampling Resampling
rsmp | Syntactic Sugar for Object Construction
rsmps | Syntactic Sugar for Object Construction

## -- S --

score_roc_measures | Calculate ROC Measures
set_threads | Set the Number of Threads
set_threads.default | Set the Number of Threads
set_threads.list | Set the Number of Threads
set_threads.R6 | Set the Number of Threads
set_validate | Syntactic Sugar for Object Construction

## -- T --

Task | Task Class
TaskClassif | Classification Task
TaskGenerator | TaskGenerator Class
TaskGenerator2DNormals | 2D Normals Classification Task Generator
TaskGeneratorCassini | Cassini Classification Task Generator
TaskGeneratorCircle | Circle Classification Task Generator
TaskGeneratorFriedman1 | Friedman1 Regression Task Generator
TaskGeneratorMoons | Moons Classification Task Generator
TaskGeneratorPeak | Peak Regression Task Generator
TaskGeneratorSimplex | Simplex Classification Task Generator
TaskGeneratorSmiley | Smiley Classification Task Generator
TaskGeneratorSpirals | Spiral Classification Task Generator
TaskGeneratorXor | XOR Classification Task Generator
TaskRegr | Regression Task
tgen | Syntactic Sugar for Object Construction
tgens | Syntactic Sugar for Object Construction
tsk | Syntactic Sugar for Object Construction
tsks | Syntactic Sugar for Object Construction

## -- U --

uhash | Obtain specific uhashes from a BenchmarkResult
uhashes | Obtain specific uhashes from a BenchmarkResult
unmarshal_model | (Un)marshal a Learner