Dictionary of Performance Measures

A simple mlr3misc::Dictionary storing objects of class Measure. Each measure has an associated help page, see mlr_measures_[id].

This dictionary can get populated with additional measures by add-on packages. E.g., mlr3proba adds survival measures and mlr3cluster adds cluster analysis measures.

For a more convenient way to retrieve and construct measures, see msr()/msrs().

Format

R6::R6Class object inheriting from mlr3misc::Dictionary.

Methods

See mlr3misc::Dictionary.

S3 methods

• as.data.table(dict)
  mlr3misc::Dictionary -> data.table::data.table()
  Returns a data.table::data.table() with fields "key", "task_type", "predict_type", and "packages" as columns.

See also

Sugar functions: msr(), msrs()

Implementation of most measures: mlr3measures

Other Dictionary: mlr_learners, mlr_resamplings, mlr_task_generators, mlr_tasks

Other Measure: MeasureClassif, MeasureRegr, Measure, mlr_measures_classif.costs, mlr_measures_debug, mlr_measures_elapsed_time, mlr_measures_oob_error, mlr_measures_selected_features

Examples

as.data.table(mlr_measures)
#>                     key task_type     packages predict_type task_properties
#>  1:         classif.acc   classif mlr3measures     response                
#>  2:         classif.auc   classif mlr3measures         prob        twoclass
#>  3:        classif.bacc   classif mlr3measures     response                
#>  4:      classif.bbrier   classif mlr3measures         prob        twoclass
#>  5:          classif.ce   classif mlr3measures     response                
#>  6:       classif.costs   classif                  response                
#>  7:         classif.dor   classif mlr3measures     response        twoclass
#>  8:       classif.fbeta   classif mlr3measures     response        twoclass
#>  9:         classif.fdr   classif mlr3measures     response        twoclass
#> 10:          classif.fn   classif mlr3measures     response        twoclass
#> 11:         classif.fnr   classif mlr3measures     response        twoclass
#> 12:        classif.fomr   classif mlr3measures     response        twoclass
#> 13:          classif.fp   classif mlr3measures     response        twoclass
#> 14:         classif.fpr   classif mlr3measures     response        twoclass
#> 15:     classif.logloss   classif mlr3measures         prob                
#> 16:      classif.mbrier   classif mlr3measures         prob                
#> 17:         classif.mcc   classif mlr3measures     response        twoclass
#> 18:         classif.npv   classif mlr3measures     response        twoclass
#> 19:         classif.ppv   classif mlr3measures     response        twoclass
#> 20:       classif.prauc   classif mlr3measures         prob        twoclass
#> 21:   classif.precision   classif mlr3measures     response        twoclass
#> 22:      classif.recall   classif mlr3measures     response        twoclass
#> 23: classif.sensitivity   classif mlr3measures     response        twoclass
#> 24: classif.specificity   classif mlr3measures     response        twoclass
#> 25:          classif.tn   classif mlr3measures     response        twoclass
#> 26:         classif.tnr   classif mlr3measures     response        twoclass
#> 27:          classif.tp   classif mlr3measures     response        twoclass
#> 28:         classif.tpr   classif mlr3measures     response        twoclass
#> 29:               debug      <NA>                  response                
#> 30:           oob_error      <NA>                  response                
#> 31:           regr.bias      regr mlr3measures     response                
#> 32:           regr.ktau      regr mlr3measures     response                
#> 33:            regr.mae      regr mlr3measures     response                
#> 34:           regr.mape      regr mlr3measures     response                
#> 35:          regr.maxae      regr mlr3measures     response                
#> 36:          regr.medae      regr mlr3measures     response                
#> 37:          regr.medse      regr mlr3measures     response                
#> 38:            regr.mse      regr mlr3measures     response                
#> 39:           regr.msle      regr mlr3measures     response                
#> 40:          regr.pbias      regr mlr3measures     response                
#> 41:            regr.rae      regr mlr3measures     response                
#> 42:           regr.rmse      regr mlr3measures     response                
#> 43:          regr.rmsle      regr mlr3measures     response                
#> 44:           regr.rrse      regr mlr3measures     response                
#> 45:            regr.rse      regr mlr3measures     response                
#> 46:            regr.rsq      regr mlr3measures     response                
#> 47:            regr.sae      regr mlr3measures     response                
#> 48:          regr.smape      regr mlr3measures     response                
#> 49:           regr.srho      regr mlr3measures     response                
#> 50:            regr.sse      regr mlr3measures     response                
#> 51:   selected_features      <NA>                  response                
#> 52:           time_both      <NA>                  response                
#> 53:        time_predict      <NA>                  response                
#> 54:          time_train      <NA>                  response                
#>                     key task_type     packages predict_type task_properties
mlr_measures$get("classif.ce")
#> <MeasureClassifSimple:classif.ce>
#> * Packages: mlr3measures
#> * Range: [0, 1]
#> * Minimize: TRUE
#> * Properties: -
#> * Predict type: response
msr("regr.mse")
#> <MeasureRegrSimple:regr.mse>
#> * Packages: mlr3measures
#> * Range: [0, Inf]
#> * Minimize: TRUE
#> * Properties: -
#> * Predict type: response