diff --git a/dev/news/index.html b/dev/news/index.html index 8ff3e3b3..18bd4097 100644 --- a/dev/news/index.html +++ b/dev/news/index.html @@ -37,11 +37,12 @@
+mlr3fselect.internal_tuning
.CRAN release: 2024-10-15
diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index 856bd999..ab7e89da 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.1.1 pkgdown_sha: ~ articles: {} -last_built: 2024-10-25T18:43Z +last_built: 2024-11-06T15:56Z urls: reference: https://mlr3fselect.mlr-org.com/reference article: https://mlr3fselect.mlr-org.com/articles diff --git a/dev/reference/AutoFSelector.html b/dev/reference/AutoFSelector.html index 2e629b70..94c46fd3 100644 --- a/dev/reference/AutoFSelector.html +++ b/dev/reference/AutoFSelector.html @@ -161,7 +161,8 @@(character(1)
)
+Identifier for the new instance.
clbk("mlr3fselect.one_se_rule")
#> <CallbackBatchFSelect:mlr3fselect.one_se_rule>: One Standard Error Rule Callback
-#> * Active Stages: on_result
+#> * Active Stages: on_optimization_end
# Run feature selection on the pima data set with the callback
instance = fselect(
diff --git a/dev/reference/mlr_fselectors_design_points.html b/dev/reference/mlr_fselectors_design_points.html
index dc0bff58..85b8df3c 100644
--- a/dev/reference/mlr_fselectors_design_points.html
+++ b/dev/reference/mlr_fselectors_design_points.html
@@ -172,10 +172,10 @@ Examples#> 4: TRUE FALSE TRUE TRUE FALSE TRUE TRUE TRUE 0.2929688
#> runtime_learners timestamp batch_nr warnings errors
#> <num> <POSc> <int> <int> <int>
-#> 1: 0.006 2024-10-25 18:44:02 1 0 0
-#> 2: 0.006 2024-10-25 18:44:02 2 0 0
-#> 3: 0.006 2024-10-25 18:44:02 3 0 0
-#> 4: 0.006 2024-10-25 18:44:02 4 0 0
+#> 1: 0.006 2024-11-06 15:56:57 1 0 0
+#> 2: 0.006 2024-11-06 15:56:57 2 0 0
+#> 3: 0.006 2024-11-06 15:56:57 3 0 0
+#> 4: 0.008 2024-11-06 15:56:57 4 0 0
#> features n_features resample_result
#> <list> <list> <list>
#> 1: age,insulin,mass,pregnant,triceps 5 <ResampleResult>
diff --git a/dev/reference/mlr_fselectors_exhaustive_search.html b/dev/reference/mlr_fselectors_exhaustive_search.html
index d8976e0a..c7c47139 100644
--- a/dev/reference/mlr_fselectors_exhaustive_search.html
+++ b/dev/reference/mlr_fselectors_exhaustive_search.html
@@ -168,16 +168,16 @@ Examples#> 10: TRUE FALSE FALSE TRUE FALSE FALSE FALSE
#> classif.ce runtime_learners timestamp batch_nr warnings errors
#> <num> <num> <POSc> <int> <int> <int>
-#> 1: 0.24347826 0.004 2024-10-25 18:44:03 1 0 0
-#> 2: 0.28695652 0.004 2024-10-25 18:44:03 1 0 0
-#> 3: 0.30434783 0.004 2024-10-25 18:44:03 1 0 0
-#> 4: 0.19130435 0.004 2024-10-25 18:44:03 1 0 0
-#> 5: 0.23478261 0.004 2024-10-25 18:44:03 1 0 0
-#> 6: 0.63478261 0.004 2024-10-25 18:44:03 1 0 0
-#> 7: 0.63478261 0.004 2024-10-25 18:44:03 1 0 0
-#> 8: 0.08695652 0.005 2024-10-25 18:44:03 1 0 0
-#> 9: 0.23478261 0.004 2024-10-25 18:44:03 1 0 0
-#> 10: 0.19130435 0.004 2024-10-25 18:44:03 1 0 0
+#> 1: 0.24347826 0.005 2024-11-06 15:56:58 1 0 0
+#> 2: 0.28695652 0.004 2024-11-06 15:56:58 1 0 0
+#> 3: 0.30434783 0.004 2024-11-06 15:56:58 1 0 0
+#> 4: 0.19130435 0.004 2024-11-06 15:56:58 1 0 0
+#> 5: 0.23478261 0.004 2024-11-06 15:56:58 1 0 0
+#> 6: 0.63478261 0.004 2024-11-06 15:56:58 1 0 0
+#> 7: 0.63478261 0.004 2024-11-06 15:56:58 1 0 0
+#> 8: 0.08695652 0.004 2024-11-06 15:56:58 1 0 0
+#> 9: 0.23478261 0.004 2024-11-06 15:56:58 1 0 0
+#> 10: 0.19130435 0.004 2024-11-06 15:56:58 1 0 0
#> features n_features resample_result
#> <list> <list> <list>
#> 1: bill_depth 1 <ResampleResult>
diff --git a/dev/reference/mlr_fselectors_genetic_search.html b/dev/reference/mlr_fselectors_genetic_search.html
index 9e9a2945..db7b1fc4 100644
--- a/dev/reference/mlr_fselectors_genetic_search.html
+++ b/dev/reference/mlr_fselectors_genetic_search.html
@@ -158,16 +158,16 @@ Examples#> 10: TRUE FALSE TRUE TRUE FALSE FALSE FALSE
#> classif.ce runtime_learners timestamp batch_nr warnings errors
#> <num> <num> <POSc> <int> <int> <int>
-#> 1: 0.6869565 0.004 2024-10-25 18:44:04 1 0 0
-#> 2: 0.2434783 0.005 2024-10-25 18:44:04 2 0 0
-#> 3: 0.6869565 0.005 2024-10-25 18:44:04 3 0 0
-#> 4: 0.2956522 0.004 2024-10-25 18:44:04 4 0 0
-#> 5: 0.3043478 0.004 2024-10-25 18:44:04 5 0 0
-#> 6: 0.2956522 0.006 2024-10-25 18:44:04 6 0 0
-#> 7: 0.1130435 0.005 2024-10-25 18:44:04 7 0 0
-#> 8: 0.3043478 0.004 2024-10-25 18:44:04 8 0 0
-#> 9: 0.2260870 0.004 2024-10-25 18:44:05 9 0 0
-#> 10: 0.2086957 0.004 2024-10-25 18:44:05 10 0 0
+#> 1: 0.6869565 0.005 2024-11-06 15:56:58 1 0 0
+#> 2: 0.2434783 0.004 2024-11-06 15:56:58 2 0 0
+#> 3: 0.6869565 0.004 2024-11-06 15:56:58 3 0 0
+#> 4: 0.2956522 0.004 2024-11-06 15:56:59 4 0 0
+#> 5: 0.3043478 0.005 2024-11-06 15:56:59 5 0 0
+#> 6: 0.2956522 0.006 2024-11-06 15:56:59 6 0 0
+#> 7: 0.1130435 0.004 2024-11-06 15:56:59 7 0 0
+#> 8: 0.3043478 0.004 2024-11-06 15:56:59 8 0 0
+#> 9: 0.2260870 0.004 2024-11-06 15:56:59 9 0 0
+#> 10: 0.2086957 0.005 2024-11-06 15:56:59 10 0 0
#> features n_features resample_result
#> <list> <list> <list>
#> 1: year 1 <ResampleResult>
diff --git a/dev/reference/mlr_fselectors_random_search.html b/dev/reference/mlr_fselectors_random_search.html
index 98dda05e..f9332977 100644
--- a/dev/reference/mlr_fselectors_random_search.html
+++ b/dev/reference/mlr_fselectors_random_search.html
@@ -177,16 +177,16 @@ Examples#> 10: TRUE FALSE TRUE TRUE TRUE TRUE TRUE
#> classif.ce runtime_learners timestamp batch_nr warnings errors
#> <num> <num> <POSc> <int> <int> <int>
-#> 1: 0.03478261 0.005 2024-10-25 18:44:05 1 0 0
-#> 2: 0.14782609 0.006 2024-10-25 18:44:05 1 0 0
-#> 3: 0.03478261 0.005 2024-10-25 18:44:05 1 0 0
-#> 4: 0.06956522 0.005 2024-10-25 18:44:05 1 0 0
-#> 5: 0.04347826 0.005 2024-10-25 18:44:05 1 0 0
-#> 6: 0.17391304 0.005 2024-10-25 18:44:05 1 0 0
-#> 7: 0.03478261 0.007 2024-10-25 18:44:05 1 0 0
-#> 8: 0.03478261 0.005 2024-10-25 18:44:05 1 0 0
-#> 9: 0.03478261 0.006 2024-10-25 18:44:05 1 0 0
-#> 10: 0.14782609 0.006 2024-10-25 18:44:05 1 0 0
+#> 1: 0.03478261 0.005 2024-11-06 15:57:00 1 0 0
+#> 2: 0.14782609 0.005 2024-11-06 15:57:00 1 0 0
+#> 3: 0.03478261 0.005 2024-11-06 15:57:00 1 0 0
+#> 4: 0.06956522 0.004 2024-11-06 15:57:00 1 0 0
+#> 5: 0.04347826 0.005 2024-11-06 15:57:00 1 0 0
+#> 6: 0.17391304 0.005 2024-11-06 15:57:00 1 0 0
+#> 7: 0.03478261 0.007 2024-11-06 15:57:00 1 0 0
+#> 8: 0.03478261 0.006 2024-11-06 15:57:00 1 0 0
+#> 9: 0.03478261 0.007 2024-11-06 15:57:00 1 0 0
+#> 10: 0.14782609 0.005 2024-11-06 15:57:00 1 0 0
#> features n_features
#> <list> <list>
#> 1: bill_depth,bill_length,flipper_length,island,year 5
diff --git a/dev/reference/mlr_fselectors_rfe.html b/dev/reference/mlr_fselectors_rfe.html
index be5b91b7..b43a797e 100644
--- a/dev/reference/mlr_fselectors_rfe.html
+++ b/dev/reference/mlr_fselectors_rfe.html
@@ -222,8 +222,8 @@ Examples#> 2: TRUE TRUE FALSE TRUE FALSE FALSE FALSE
#> classif.ce runtime_learners timestamp batch_nr warnings errors
#> <num> <num> <POSc> <int> <int> <int>
-#> 1: 0.05217391 0.006 2024-10-25 18:44:06 1 0 0
-#> 2: 0.06086957 0.005 2024-10-25 18:44:06 2 0 0
+#> 1: 0.05217391 0.005 2024-11-06 15:57:00 1 0 0
+#> 2: 0.06086957 0.004 2024-11-06 15:57:00 2 0 0
#> importance
#> <list>
#> 1: 7,6,5,4,3,2,...
diff --git a/dev/reference/mlr_fselectors_rfecv.html b/dev/reference/mlr_fselectors_rfecv.html
index dc1d4d31..cbcb4ea5 100644
--- a/dev/reference/mlr_fselectors_rfecv.html
+++ b/dev/reference/mlr_fselectors_rfecv.html
@@ -217,14 +217,14 @@ Examples#> 8: TRUE TRUE FALSE TRUE FALSE FALSE FALSE
#> classif.ce runtime_learners timestamp batch_nr warnings errors
#> <num> <num> <POSc> <int> <int> <int>
-#> 1: 0.07826087 0.008 2024-10-25 18:44:07 1 0 0
-#> 2: 0.07826087 0.007 2024-10-25 18:44:07 1 0 0
-#> 3: 0.05263158 0.005 2024-10-25 18:44:07 1 0 0
-#> 4: 0.12173913 0.005 2024-10-25 18:44:07 2 0 0
-#> 5: 0.07826087 0.005 2024-10-25 18:44:07 2 0 0
-#> 6: 0.06140351 0.005 2024-10-25 18:44:07 2 0 0
-#> 7: 0.03488372 0.005 2024-10-25 18:44:07 3 0 0
-#> 8: 0.03779070 0.005 2024-10-25 18:44:07 4 0 0
+#> 1: 0.07826087 0.007 2024-11-06 15:57:01 1 0 0
+#> 2: 0.07826087 0.007 2024-11-06 15:57:01 1 0 0
+#> 3: 0.05263158 0.005 2024-11-06 15:57:01 1 0 0
+#> 4: 0.12173913 0.005 2024-11-06 15:57:01 2 0 0
+#> 5: 0.07826087 0.004 2024-11-06 15:57:01 2 0 0
+#> 6: 0.06140351 0.004 2024-11-06 15:57:01 2 0 0
+#> 7: 0.03488372 0.006 2024-11-06 15:57:01 3 0 0
+#> 8: 0.03779070 0.005 2024-11-06 15:57:02 4 0 0
#> importance iteration
#> <list> <int>
#> 1: 90.52138,81.73374,80.53600,80.52697,75.98572, 2.70389,... 1
diff --git a/dev/reference/mlr_fselectors_sequential.html b/dev/reference/mlr_fselectors_sequential.html
index 09bc1f94..2353fe36 100644
--- a/dev/reference/mlr_fselectors_sequential.html
+++ b/dev/reference/mlr_fselectors_sequential.html
@@ -204,19 +204,19 @@ Examples#> 13: FALSE FALSE FALSE TRUE FALSE FALSE TRUE
#> classif.ce runtime_learners timestamp batch_nr warnings errors
#> <num> <num> <POSc> <int> <int> <int>
-#> 1: 0.28695652 0.005 2024-10-25 18:44:08 1 0 0
-#> 2: 0.27826087 0.004 2024-10-25 18:44:08 1 0 0
-#> 3: 0.35652174 0.004 2024-10-25 18:44:08 1 0 0
-#> 4: 0.26086957 0.004 2024-10-25 18:44:08 1 0 0
-#> 5: 0.39130435 0.005 2024-10-25 18:44:08 1 0 0
-#> 6: 0.55652174 0.004 2024-10-25 18:44:08 1 0 0
-#> 7: 0.65217391 0.004 2024-10-25 18:44:08 1 0 0
-#> 8: 0.29565217 0.005 2024-10-25 18:44:08 2 0 0
-#> 9: 0.07826087 0.004 2024-10-25 18:44:08 2 0 0
-#> 10: 0.20000000 0.004 2024-10-25 18:44:08 2 0 0
-#> 11: 0.13043478 0.004 2024-10-25 18:44:08 2 0 0
-#> 12: 0.20869565 0.005 2024-10-25 18:44:08 2 0 0
-#> 13: 0.26086957 0.005 2024-10-25 18:44:08 2 0 0
+#> 1: 0.28695652 0.004 2024-11-06 15:57:02 1 0 0
+#> 2: 0.27826087 0.004 2024-11-06 15:57:02 1 0 0
+#> 3: 0.35652174 0.004 2024-11-06 15:57:02 1 0 0
+#> 4: 0.26086957 0.005 2024-11-06 15:57:02 1 0 0
+#> 5: 0.39130435 0.005 2024-11-06 15:57:02 1 0 0
+#> 6: 0.55652174 0.004 2024-11-06 15:57:02 1 0 0
+#> 7: 0.65217391 0.004 2024-11-06 15:57:02 1 0 0
+#> 8: 0.29565217 0.005 2024-11-06 15:57:03 2 0 0
+#> 9: 0.07826087 0.004 2024-11-06 15:57:03 2 0 0
+#> 10: 0.20000000 0.004 2024-11-06 15:57:03 2 0 0
+#> 11: 0.13043478 0.005 2024-11-06 15:57:03 2 0 0
+#> 12: 0.20869565 0.005 2024-11-06 15:57:03 2 0 0
+#> 13: 0.26086957 0.004 2024-11-06 15:57:03 2 0 0
#> features n_features resample_result
#> <list> <list> <list>
#> 1: bill_depth 1 <ResampleResult>
diff --git a/dev/reference/mlr_fselectors_shadow_variable_search.html b/dev/reference/mlr_fselectors_shadow_variable_search.html
index 6e1e05a0..79f02026 100644
--- a/dev/reference/mlr_fselectors_shadow_variable_search.html
+++ b/dev/reference/mlr_fselectors_shadow_variable_search.html
@@ -238,56 +238,56 @@ Examples#> bill_depth bill_length body_mass flipper_length island sex year
#> classif.ce runtime_learners timestamp batch_nr
#> <num> <num> <POSc> <int>
-#> 1: 0.32173913 0.012 2024-10-25 18:44:09 1
-#> 2: 0.25217391 0.011 2024-10-25 18:44:09 1
-#> 3: 0.26956522 0.011 2024-10-25 18:44:09 1
-#> 4: 0.20869565 0.012 2024-10-25 18:44:09 1
-#> 5: 0.28695652 0.011 2024-10-25 18:44:09 1
-#> 6: 0.54782609 0.011 2024-10-25 18:44:09 1
-#> 7: 0.54782609 0.011 2024-10-25 18:44:09 1
-#> 8: 0.50434783 0.010 2024-10-25 18:44:09 1
-#> 9: 0.58260870 0.010 2024-10-25 18:44:09 1
-#> 10: 0.53043478 0.009 2024-10-25 18:44:09 1
-#> 11: 0.56521739 0.010 2024-10-25 18:44:09 1
-#> 12: 0.59130435 0.010 2024-10-25 18:44:09 1
-#> 13: 0.54782609 0.014 2024-10-25 18:44:09 1
-#> 14: 0.54782609 0.012 2024-10-25 18:44:09 1
-#> 15: 0.20869565 0.012 2024-10-25 18:44:10 2
-#> 16: 0.05217391 0.011 2024-10-25 18:44:10 2
-#> 17: 0.20000000 0.011 2024-10-25 18:44:10 2
-#> 18: 0.13913043 0.011 2024-10-25 18:44:10 2
-#> 19: 0.20869565 0.011 2024-10-25 18:44:10 2
-#> 20: 0.20000000 0.011 2024-10-25 18:44:10 2
-#> 21: 0.20869565 0.011 2024-10-25 18:44:10 2
-#> 22: 0.20869565 0.016 2024-10-25 18:44:10 2
-#> 23: 0.21739130 0.014 2024-10-25 18:44:10 2
-#> 24: 0.19130435 0.012 2024-10-25 18:44:10 2
-#> 25: 0.20869565 0.011 2024-10-25 18:44:10 2
-#> 26: 0.20869565 0.012 2024-10-25 18:44:10 2
-#> 27: 0.20869565 0.012 2024-10-25 18:44:10 2
-#> 28: 0.05217391 0.012 2024-10-25 18:44:10 3
-#> 29: 0.05217391 0.011 2024-10-25 18:44:10 3
-#> 30: 0.04347826 0.011 2024-10-25 18:44:10 3
-#> 31: 0.05217391 0.015 2024-10-25 18:44:10 3
-#> 32: 0.05217391 0.016 2024-10-25 18:44:10 3
-#> 33: 0.05217391 0.012 2024-10-25 18:44:10 3
-#> 34: 0.05217391 0.012 2024-10-25 18:44:10 3
-#> 35: 0.05217391 0.011 2024-10-25 18:44:10 3
-#> 36: 0.05217391 0.012 2024-10-25 18:44:10 3
-#> 37: 0.05217391 0.012 2024-10-25 18:44:10 3
-#> 38: 0.05217391 0.012 2024-10-25 18:44:10 3
-#> 39: 0.05217391 0.011 2024-10-25 18:44:10 3
-#> 40: 0.04347826 0.013 2024-10-25 18:44:11 4
-#> 41: 0.04347826 0.036 2024-10-25 18:44:11 4
-#> 42: 0.04347826 0.015 2024-10-25 18:44:11 4
-#> 43: 0.04347826 0.012 2024-10-25 18:44:11 4
-#> 44: 0.04347826 0.012 2024-10-25 18:44:11 4
-#> 45: 0.04347826 0.012 2024-10-25 18:44:11 4
-#> 46: 0.04347826 0.012 2024-10-25 18:44:11 4
-#> 47: 0.04347826 0.013 2024-10-25 18:44:11 4
-#> 48: 0.04347826 0.012 2024-10-25 18:44:11 4
-#> 49: 0.04347826 0.012 2024-10-25 18:44:11 4
-#> 50: 0.04347826 0.011 2024-10-25 18:44:11 4
+#> 1: 0.32173913 0.012 2024-11-06 15:57:04 1
+#> 2: 0.25217391 0.012 2024-11-06 15:57:04 1
+#> 3: 0.26956522 0.012 2024-11-06 15:57:04 1
+#> 4: 0.20869565 0.011 2024-11-06 15:57:04 1
+#> 5: 0.28695652 0.011 2024-11-06 15:57:04 1
+#> 6: 0.54782609 0.011 2024-11-06 15:57:04 1
+#> 7: 0.54782609 0.011 2024-11-06 15:57:04 1
+#> 8: 0.50434783 0.010 2024-11-06 15:57:04 1
+#> 9: 0.58260870 0.010 2024-11-06 15:57:04 1
+#> 10: 0.53043478 0.009 2024-11-06 15:57:04 1
+#> 11: 0.56521739 0.011 2024-11-06 15:57:04 1
+#> 12: 0.59130435 0.010 2024-11-06 15:57:04 1
+#> 13: 0.54782609 0.014 2024-11-06 15:57:04 1
+#> 14: 0.54782609 0.012 2024-11-06 15:57:04 1
+#> 15: 0.20869565 0.012 2024-11-06 15:57:04 2
+#> 16: 0.05217391 0.012 2024-11-06 15:57:04 2
+#> 17: 0.20000000 0.012 2024-11-06 15:57:04 2
+#> 18: 0.13913043 0.011 2024-11-06 15:57:04 2
+#> 19: 0.20869565 0.011 2024-11-06 15:57:04 2
+#> 20: 0.20000000 0.012 2024-11-06 15:57:04 2
+#> 21: 0.20869565 0.012 2024-11-06 15:57:04 2
+#> 22: 0.20869565 0.015 2024-11-06 15:57:04 2
+#> 23: 0.21739130 0.015 2024-11-06 15:57:04 2
+#> 24: 0.19130435 0.012 2024-11-06 15:57:04 2
+#> 25: 0.20869565 0.012 2024-11-06 15:57:04 2
+#> 26: 0.20869565 0.012 2024-11-06 15:57:04 2
+#> 27: 0.20869565 0.012 2024-11-06 15:57:04 2
+#> 28: 0.05217391 0.012 2024-11-06 15:57:04 3
+#> 29: 0.05217391 0.011 2024-11-06 15:57:04 3
+#> 30: 0.04347826 0.012 2024-11-06 15:57:04 3
+#> 31: 0.05217391 0.035 2024-11-06 15:57:04 3
+#> 32: 0.05217391 0.016 2024-11-06 15:57:04 3
+#> 33: 0.05217391 0.012 2024-11-06 15:57:04 3
+#> 34: 0.05217391 0.012 2024-11-06 15:57:04 3
+#> 35: 0.05217391 0.011 2024-11-06 15:57:04 3
+#> 36: 0.05217391 0.012 2024-11-06 15:57:04 3
+#> 37: 0.05217391 0.013 2024-11-06 15:57:04 3
+#> 38: 0.05217391 0.012 2024-11-06 15:57:04 3
+#> 39: 0.05217391 0.011 2024-11-06 15:57:04 3
+#> 40: 0.04347826 0.013 2024-11-06 15:57:05 4
+#> 41: 0.04347826 0.035 2024-11-06 15:57:05 4
+#> 42: 0.04347826 0.016 2024-11-06 15:57:05 4
+#> 43: 0.04347826 0.012 2024-11-06 15:57:05 4
+#> 44: 0.04347826 0.012 2024-11-06 15:57:05 4
+#> 45: 0.04347826 0.011 2024-11-06 15:57:05 4
+#> 46: 0.04347826 0.012 2024-11-06 15:57:05 4
+#> 47: 0.04347826 0.013 2024-11-06 15:57:05 4
+#> 48: 0.04347826 0.012 2024-11-06 15:57:05 4
+#> 49: 0.04347826 0.011 2024-11-06 15:57:05 4
+#> 50: 0.04347826 0.012 2024-11-06 15:57:05 4
#> classif.ce runtime_learners timestamp batch_nr
#> permuted__bill_depth permuted__bill_length permuted__body_mass
#> <lgcl> <lgcl> <lgcl>
diff --git a/dev/search.json b/dev/search.json
index deaacd2c..6a2a4f1c 100644
--- a/dev/search.json
+++ b/dev/search.json
@@ -1 +1 @@
-[{"path":"https://mlr3fselect.mlr-org.com/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Marc Becker. Author, maintainer. Patrick Schratz. Author. Michel Lang. Author. Bernd Bischl. Author. John Zobolas. Author.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Becker M, Schratz P, Lang M, Bischl B, Zobolas J (2024). mlr3fselect: Feature Selection 'mlr3'. R package version 1.2.0.9000, https://github.com/mlr-org/mlr3fselect, https://mlr3fselect.mlr-org.com.","code":"@Manual{, title = {mlr3fselect: Feature Selection for 'mlr3'}, author = {Marc Becker and Patrick Schratz and Michel Lang and Bernd Bischl and John Zobolas}, year = {2024}, note = {R package version 1.2.0.9000, https://github.com/mlr-org/mlr3fselect}, url = {https://mlr3fselect.mlr-org.com}, }"},{"path":"https://mlr3fselect.mlr-org.com/dev/index.html","id":"mlr3fselect-","dir":"","previous_headings":"","what":"Feature Selection for mlr3","title":"Feature Selection for mlr3","text":"Package website: release | dev mlr3fselect feature selection package mlr3 ecosystem. selects optimal feature set mlr3 learner. package works several optimization algorithms e.g. Random Search, Recursive Feature Elimination, Genetic Search. Moreover, can automatically optimize learners estimate performance optimized feature sets nested resampling. package built optimization framework bbotk.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/index.html","id":"resources","dir":"","previous_headings":"","what":"Resources","title":"Feature Selection for mlr3","text":"several section feature selection mlr3book. Getting started wrapper feature selection. sequential forward selection Palmer Penguins data set. Optimize multiple performance measures. Estimate Model Performance nested resampling. gallery features collection case studies demos optimization. Utilize built-feature importance models Recursive Feature Elimination. Run feature selection Shadow Variable Search. Feature Selection Titanic data set. cheatsheet summarizes important functions mlr3fselect.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Feature Selection for mlr3","text":"Install last release CRAN: Install development version GitHub:","code":"install.packages(\"mlr3fselect\") remotes::install_github(\"mlr-org/mlr3fselect\")"},{"path":"https://mlr3fselect.mlr-org.com/dev/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Feature Selection for mlr3","text":"run feature selection support vector machine Spam data set. construct instance fsi() function. instance describes optimization problem. select simple random search optimization algorithm. start feature selection, simply pass instance fselector. fselector writes best hyperparameter configuration instance. corresponding measured performance. archive contains evaluated hyperparameter configurations. fit final model optimized feature set make predictions new data.","code":"library(\"mlr3verse\") tsk(\"spam\") ## (4601 x 58): HP Spam Detection ## * Target: type ## * Properties: twoclass ## * Features (57): ## - dbl (57): address, addresses, all, business, capitalAve, capitalLong, capitalTotal, ## charDollar, charExclamation, charHash, charRoundbracket, charSemicolon, ## charSquarebracket, conference, credit, cs, data, direct, edu, email, font, free, ## george, hp, hpl, internet, lab, labs, mail, make, meeting, money, num000, num1999, ## num3d, num415, num650, num85, num857, order, original, our, over, parts, people, pm, ## project, re, receive, remove, report, table, technology, telnet, will, you, your instance = fsi( task = tsk(\"spam\"), learner = lrn(\"classif.svm\", type = \"C-classification\"), resampling = rsmp(\"cv\", folds = 3), measures = msr(\"classif.ce\"), terminator = trm(\"evals\", n_evals = 20) ) instance ## ## * State: Not optimized ## * Objective: ## * Terminator: fselector = fs(\"random_search\", batch_size = 5) fselector ## : Random Search ## * Parameters: batch_size=5 ## * Properties: single-crit, multi-crit ## * Packages: mlr3fselect fselector$optimize(instance) instance$result_feature_set ## [1] \"address\" \"addresses\" \"all\" \"business\" ## [5] \"capitalAve\" \"capitalLong\" \"capitalTotal\" \"charDollar\" ## [9] \"charExclamation\" \"charHash\" \"charRoundbracket\" \"charSemicolon\" ## [13] \"charSquarebracket\" \"conference\" \"credit\" \"cs\" ## [17] \"data\" \"direct\" \"edu\" \"email\" ## [21] \"font\" \"free\" \"george\" \"hp\" ## [25] \"internet\" \"lab\" \"labs\" \"mail\" ## [29] \"make\" \"meeting\" \"money\" \"num000\" ## [33] \"num1999\" \"num3d\" \"num415\" \"num650\" ## [37] \"num85\" \"num857\" \"order\" \"our\" ## [41] \"parts\" \"people\" \"pm\" \"project\" ## [45] \"re\" \"receive\" \"remove\" \"report\" ## [49] \"table\" \"technology\" \"telnet\" \"will\" ## [53] \"you\" \"your\" instance$result_y ## classif.ce ## 0.07042005 as.data.table(instance$archive) ## address addresses all business capitalAve capitalLong capitalTotal charDollar charExclamation ## 1: TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE ## 2: TRUE TRUE TRUE FALSE FALSE TRUE TRUE TRUE TRUE ## 3: TRUE TRUE FALSE FALSE TRUE TRUE TRUE TRUE TRUE ## 4: TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE ## 5: FALSE FALSE FALSE FALSE FALSE FALSE FALSE TRUE FALSE ## --- ## 16: FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE ## 17: FALSE FALSE FALSE TRUE TRUE TRUE FALSE FALSE TRUE ## 18: FALSE FALSE TRUE TRUE FALSE FALSE FALSE TRUE FALSE ## 19: TRUE TRUE TRUE TRUE FALSE TRUE TRUE TRUE TRUE ## 20: TRUE FALSE TRUE FALSE FALSE TRUE FALSE TRUE FALSE ## 56 variables not shown: [charHash, charRoundbracket, charSemicolon, charSquarebracket, conference, credit, cs, data, direct, edu, ...] task = tsk(\"spam\") learner = lrn(\"classif.svm\", type = \"C-classification\") task$select(instance$result_feature_set) learner$train(task)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":null,"dir":"Reference","previous_headings":"","what":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"ArchiveBatchFSelect stores evaluated feature sets performance scores.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"ArchiveBatchFSelect container around data.table::data.table(). row corresponds single evaluation feature set. See section Data Structure information. archive stores additionally mlr3::BenchmarkResult ($benchmark_result) records resampling experiments. experiment corresponds single evaluation feature set. table ($data) benchmark result ($benchmark_result) linked uhash column. archive passed .data.table(), joined automatically.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"data-structure","dir":"Reference","previous_headings":"","what":"Data structure","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"table ($data) following columns: One column feature task ($search_space). One column performance measure ($codomain). runtime_learners (numeric(1)) Sum training predict times logged learners per mlr3::ResampleResult / evaluation. include potential overhead time. timestamp (POSIXct) Time stamp evaluation logged archive. batch_nr (integer(1)) Feature sets evaluated batches. batch unique batch number. uhash (character(1)) Connects feature set resampling experiment stored mlr3::BenchmarkResult.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"analysis","dir":"Reference","previous_headings":"","what":"Analysis","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"analyzing feature selection results, recommended pass archive .data.table(). returned data table joined benchmark result adds mlr3::ResampleResult feature set. archive provides various getters (e.g. $learners()) ease access. getters extract position () unique hash (uhash). complete list getters see methods section. benchmark result ($benchmark_result) allows score feature sets different measure. Alternatively, measures can supplied .data.table().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"s-methods","dir":"Reference","previous_headings":"","what":"S3 Methods","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":".data.table.ArchiveBatchFSelect(x, exclude_columns = \"uhash\", measures = NULL) Returns tabular view evaluated feature sets. ArchiveBatchFSelect -> data.table::data.table() x (ArchiveBatchFSelect) exclude_columns (character()) Exclude columns table. Set NULL column excluded. measures (list mlr3::Measure) Score feature sets additional measures.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"bbotk::Archive -> bbotk::ArchiveBatch -> ArchiveBatchFSelect","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"benchmark_result (mlr3::BenchmarkResult) Benchmark result.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"ties_method (character(1)) Method handle ties.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"bbotk::Archive$format() bbotk::Archive$help() bbotk::ArchiveBatch$clear() bbotk::ArchiveBatch$nds_selection()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"ArchiveBatchFSelect$new() ArchiveBatchFSelect$add_evals() ArchiveBatchFSelect$learner() ArchiveBatchFSelect$learners() ArchiveBatchFSelect$predictions() ArchiveBatchFSelect$resample_result() ArchiveBatchFSelect$print() ArchiveBatchFSelect$best() ArchiveBatchFSelect$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"","code":"ArchiveBatchFSelect$new( search_space, codomain, check_values = TRUE, ties_method = \"least_features\" )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"search_space (paradox::ParamSet) Search space. Internally created provided mlr3::Task instance. codomain (bbotk::Codomain) Specifies codomain objective function .e. set performance measures. Internally created provided mlr3::Measures instance. check_values (logical(1)) TRUE (default), hyperparameter configurations check validity. ties_method (character(1)) method break ties selecting sets optimizing selecting best set. Can \"least_features\" \"random\". option \"least_features\" (default) selects feature set least features. multiple best feature sets number features, one selected randomly. random method returns random feature set best feature sets. Ignored multiple measures used.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"method-add-evals-","dir":"Reference","previous_headings":"","what":"Method add_evals()","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"Adds function evaluations archive table.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"","code":"ArchiveBatchFSelect$add_evals(xdt, xss_trafoed = NULL, ydt)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"xdt (data.table::data.table()) x values data.table. row one point. Contains value search space FSelectInstanceBatchMultiCrit object. Can contain additional columns extra information. xss_trafoed (list()) Ignored feature selection. ydt (data.table::data.table()) Optimal outcome.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"method-learner-","dir":"Reference","previous_headings":"","what":"Method learner()","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"Retrieve mlr3::Learner -th evaluation, position unique hash uhash. uhash mutually exclusive. Learner contain model. Use $learners() get learners models.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"","code":"ArchiveBatchFSelect$learner(i = NULL, uhash = NULL)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"(integer(1)) iteration value filter . uhash (logical(1)) uhash value filter .","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"method-learners-","dir":"Reference","previous_headings":"","what":"Method learners()","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"Retrieve list trained mlr3::Learner objects -th evaluation, position unique hash uhash. uhash mutually exclusive.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"","code":"ArchiveBatchFSelect$learners(i = NULL, uhash = NULL)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"(integer(1)) iteration value filter . uhash (logical(1)) uhash value filter .","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"method-predictions-","dir":"Reference","previous_headings":"","what":"Method predictions()","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"Retrieve list mlr3::Prediction objects -th evaluation, position unique hash uhash. uhash mutually exclusive.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"","code":"ArchiveBatchFSelect$predictions(i = NULL, uhash = NULL)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"(integer(1)) iteration value filter . uhash (logical(1)) uhash value filter .","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"method-resample-result-","dir":"Reference","previous_headings":"","what":"Method resample_result()","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"Retrieve mlr3::ResampleResult -th evaluation, position unique hash uhash. uhash mutually exclusive.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"","code":"ArchiveBatchFSelect$resample_result(i = NULL, uhash = NULL)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"(integer(1)) iteration value filter . uhash (logical(1)) uhash value filter .","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"Printer.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"","code":"ArchiveBatchFSelect$print()"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"... (ignored).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"method-best-","dir":"Reference","previous_headings":"","what":"Method best()","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"Returns best scoring feature sets.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"","code":"ArchiveBatchFSelect$best(batch = NULL, ties_method = NULL)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"batch (integer()) batch number(s) limit best results . Default batches. ties_method (character(1)) Method handle ties. NULL (default), global ties method set initialization used. default global ties method least_features selects feature set least features. multiple best feature sets number features, one selected randomly. random method returns random feature set best feature sets.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"data.table::data.table()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"","code":"ArchiveBatchFSelect$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ArchiveBatchFSelect.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Logging Evaluated Feature Sets — ArchiveBatchFSelect","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":null,"dir":"Reference","previous_headings":"","what":"Class for Automatic Feature Selection — AutoFSelector","title":"Class for Automatic Feature Selection — AutoFSelector","text":"AutoFSelector wraps mlr3::Learner augments automatic feature selection. auto_fselector() function creates AutoFSelector object.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Class for Automatic Feature Selection — AutoFSelector","text":"AutoFSelector mlr3::Learner wraps another mlr3::Learner performs following steps $train(): wrapped (inner) learner trained feature subsets via resampling. feature selection can specified providing FSelector, bbotk::Terminator, mlr3::Resampling mlr3::Measure. final model fit complete training data best-found feature subset. $predict() AutoFSelector just calls predict method wrapped (inner) learner.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"resources","dir":"Reference","previous_headings":"","what":"Resources","title":"Class for Automatic Feature Selection — AutoFSelector","text":"several sections feature selection mlr3book. Estimate Model Performance nested resampling. gallery features collection case studies demos optimization.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"nested-resampling","dir":"Reference","previous_headings":"","what":"Nested Resampling","title":"Class for Automatic Feature Selection — AutoFSelector","text":"Nested resampling can performed passing AutoFSelector object mlr3::resample() mlr3::benchmark(). access inner resampling results, set store_fselect_instance = TRUE execute mlr3::resample() mlr3::benchmark() store_models = TRUE (see examples). mlr3::Resampling passed AutoFSelector meant inner resampling, operating training set arbitrary outer resampling. reason feasible pass instantiated mlr3::Resampling .","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Class for Automatic Feature Selection — AutoFSelector","text":"mlr3::Learner -> AutoFSelector","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Class for Automatic Feature Selection — AutoFSelector","text":"instance_args (list()) arguments construction create FSelectInstanceBatchSingleCrit. fselector (FSelector) Optimization algorithm.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Class for Automatic Feature Selection — AutoFSelector","text":"archive ([ArchiveBatchFSelect) Returns FSelectInstanceBatchSingleCrit archive. learner (mlr3::Learner) Trained learner. fselect_instance (FSelectInstanceBatchSingleCrit) Internally created feature selection instance intermediate results. fselect_result (data.table::data.table) Short-cut $result FSelectInstanceBatchSingleCrit. predict_type (character(1)) Stores currently active predict type, e.g. \"response\". Must element $predict_types. hash (character(1)) Hash (unique identifier) object. phash (character(1)) Hash (unique identifier) partial object, excluding components varied systematically tuning (parameter values) feature selection (feature names).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Class for Automatic Feature Selection — AutoFSelector","text":"mlr3::Learner$encapsulate() mlr3::Learner$format() mlr3::Learner$help() mlr3::Learner$predict() mlr3::Learner$predict_newdata() mlr3::Learner$reset() mlr3::Learner$train()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Class for Automatic Feature Selection — AutoFSelector","text":"AutoFSelector$new() AutoFSelector$base_learner() AutoFSelector$importance() AutoFSelector$selected_features() AutoFSelector$oob_error() AutoFSelector$loglik() AutoFSelector$print() AutoFSelector$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Class for Automatic Feature Selection — AutoFSelector","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Automatic Feature Selection — AutoFSelector","text":"","code":"AutoFSelector$new( fselector, learner, resampling, measure = NULL, terminator, store_fselect_instance = TRUE, store_benchmark_result = TRUE, store_models = FALSE, check_values = FALSE, callbacks = NULL, ties_method = \"least_features\" )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Automatic Feature Selection — AutoFSelector","text":"fselector (FSelector) Optimization algorithm. learner (mlr3::Learner) Learner optimize feature subset . resampling (mlr3::Resampling) Resampling used evaluated performance feature subsets. Uninstantiated resamplings instantiated construction feature subsets evaluated data splits. Already instantiated resamplings kept unchanged. measure (mlr3::Measure) Measure optimize. NULL, default measure used. terminator (bbotk::Terminator) Stop criterion feature selection. store_fselect_instance (logical(1)) TRUE (default), stores internally created FSelectInstanceBatchSingleCrit intermediate results slot $fselect_instance. set TRUE, store_models = TRUE store_benchmark_result (logical(1)) Store benchmark result archive? store_models (logical(1)). Store models benchmark result? check_values (logical(1)) Check parameters evaluation results validity? callbacks (list CallbackBatchFSelect) List callbacks. ties_method (character(1)) method break ties selecting sets optimizing selecting best set. Can \"least_features\" \"random\". option \"least_features\" (default) selects feature set least features. multiple best feature sets number features, one selected randomly. random method returns random feature set best feature sets. Ignored multiple measures used.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"method-base-learner-","dir":"Reference","previous_headings":"","what":"Method base_learner()","title":"Class for Automatic Feature Selection — AutoFSelector","text":"Extracts base learner nested learner objects like GraphLearner mlr3pipelines. recursive = 0, (tuned) learner returned.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Automatic Feature Selection — AutoFSelector","text":"","code":"AutoFSelector$base_learner(recursive = Inf)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Automatic Feature Selection — AutoFSelector","text":"recursive (integer(1)) Depth recursion multiple nested objects.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Class for Automatic Feature Selection — AutoFSelector","text":"mlr3::Learner.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"method-importance-","dir":"Reference","previous_headings":"","what":"Method importance()","title":"Class for Automatic Feature Selection — AutoFSelector","text":"importance scores final model.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Automatic Feature Selection — AutoFSelector","text":"","code":"AutoFSelector$importance()"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Class for Automatic Feature Selection — AutoFSelector","text":"Named numeric().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"method-selected-features-","dir":"Reference","previous_headings":"","what":"Method selected_features()","title":"Class for Automatic Feature Selection — AutoFSelector","text":"selected features final model. features selected internally learner.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Automatic Feature Selection — AutoFSelector","text":"","code":"AutoFSelector$selected_features()"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Class for Automatic Feature Selection — AutoFSelector","text":"character().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"method-oob-error-","dir":"Reference","previous_headings":"","what":"Method oob_error()","title":"Class for Automatic Feature Selection — AutoFSelector","text":"--bag error final model.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Automatic Feature Selection — AutoFSelector","text":"","code":"AutoFSelector$oob_error()"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Class for Automatic Feature Selection — AutoFSelector","text":"numeric(1).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"method-loglik-","dir":"Reference","previous_headings":"","what":"Method loglik()","title":"Class for Automatic Feature Selection — AutoFSelector","text":"log-likelihood final model.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Automatic Feature Selection — AutoFSelector","text":"","code":"AutoFSelector$loglik()"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"Class for Automatic Feature Selection — AutoFSelector","text":"logLik. Printer.","code":""},{"path":[]},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Automatic Feature Selection — AutoFSelector","text":"","code":"AutoFSelector$print()"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Automatic Feature Selection — AutoFSelector","text":"... (ignored).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Class for Automatic Feature Selection — AutoFSelector","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Automatic Feature Selection — AutoFSelector","text":"","code":"AutoFSelector$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Automatic Feature Selection — AutoFSelector","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/AutoFSelector.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Class for Automatic Feature Selection — AutoFSelector","text":"","code":"# Automatic Feature Selection # \\donttest{ # split to train and external set task = tsk(\"penguins\") split = partition(task, ratio = 0.8) # create auto fselector afs = auto_fselector( fselector = fs(\"random_search\"), learner = lrn(\"classif.rpart\"), resampling = rsmp (\"holdout\"), measure = msr(\"classif.ce\"), term_evals = 4) # optimize feature subset and fit final model afs$train(task, row_ids = split$train) # predict with final model afs$predict(task, row_ids = split$test) #> for 69 observations: #> row_ids truth response #> 1 Adelie Adelie #> 2 Adelie Adelie #> 9 Adelie Adelie #> --- --- --- #> 318 Chinstrap Chinstrap #> 334 Chinstrap Chinstrap #> 338 Chinstrap Chinstrap # show result afs$fselect_result #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: FALSE TRUE FALSE FALSE TRUE TRUE TRUE #> features n_features classif.ce #> #> 1: bill_length,island,sex,year 4 0.06521739 # model slot contains trained learner and fselect instance afs$model #> $learner #> : Classification Tree #> * Model: rpart #> * Parameters: xval=0 #> * Packages: mlr3, rpart #> * Predict Types: [response], prob #> * Feature Types: logical, integer, numeric, factor, ordered #> * Properties: importance, missings, multiclass, selected_features, #> twoclass, weights #> #> $features #> [1] \"bill_length\" \"island\" \"sex\" \"year\" #> #> $fselect_instance #> #> * State: Optimized #> * Objective: #> * Terminator: #> * Result: #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: FALSE TRUE FALSE FALSE TRUE TRUE TRUE #> classif.ce #> #> 1: 0.06521739 #> * Archive: #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 2: FALSE TRUE FALSE FALSE TRUE TRUE TRUE #> 3: FALSE FALSE FALSE TRUE FALSE FALSE FALSE #> 4: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 5: TRUE TRUE TRUE TRUE FALSE TRUE TRUE #> 6: FALSE TRUE TRUE TRUE FALSE FALSE TRUE #> 7: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 8: TRUE TRUE FALSE FALSE FALSE FALSE TRUE #> 9: TRUE FALSE FALSE FALSE FALSE FALSE FALSE #> 10: TRUE FALSE TRUE FALSE FALSE TRUE FALSE #> classif.ce #> #> 1: 0.09782609 #> 2: 0.06521739 #> 3: 0.25000000 #> 4: 0.09782609 #> 5: 0.09782609 #> 6: 0.09782609 #> 7: 0.09782609 #> 8: 0.07608696 #> 9: 0.29347826 #> 10: 0.20652174 #> # shortcut trained learner afs$learner #> : Classification Tree #> * Model: rpart #> * Parameters: xval=0 #> * Packages: mlr3, rpart #> * Predict Types: [response], prob #> * Feature Types: logical, integer, numeric, factor, ordered #> * Properties: importance, missings, multiclass, selected_features, #> twoclass, weights # shortcut fselect instance afs$fselect_instance #> #> * State: Optimized #> * Objective: #> * Terminator: #> * Result: #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: FALSE TRUE FALSE FALSE TRUE TRUE TRUE #> classif.ce #> #> 1: 0.06521739 #> * Archive: #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 2: FALSE TRUE FALSE FALSE TRUE TRUE TRUE #> 3: FALSE FALSE FALSE TRUE FALSE FALSE FALSE #> 4: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 5: TRUE TRUE TRUE TRUE FALSE TRUE TRUE #> 6: FALSE TRUE TRUE TRUE FALSE FALSE TRUE #> 7: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 8: TRUE TRUE FALSE FALSE FALSE FALSE TRUE #> 9: TRUE FALSE FALSE FALSE FALSE FALSE FALSE #> 10: TRUE FALSE TRUE FALSE FALSE TRUE FALSE #> classif.ce #> #> 1: 0.09782609 #> 2: 0.06521739 #> 3: 0.25000000 #> 4: 0.09782609 #> 5: 0.09782609 #> 6: 0.09782609 #> 7: 0.09782609 #> 8: 0.07608696 #> 9: 0.29347826 #> 10: 0.20652174 # Nested Resampling afs = auto_fselector( fselector = fs(\"random_search\"), learner = lrn(\"classif.rpart\"), resampling = rsmp (\"holdout\"), measure = msr(\"classif.ce\"), term_evals = 4) resampling_outer = rsmp(\"cv\", folds = 3) rr = resample(task, afs, resampling_outer, store_models = TRUE) # retrieve inner feature selection results. extract_inner_fselect_results(rr) #> iteration bill_depth bill_length body_mass flipper_length island sex #> #> 1: 1 TRUE TRUE FALSE FALSE TRUE TRUE #> 2: 2 FALSE TRUE FALSE TRUE FALSE FALSE #> 3: 3 FALSE TRUE TRUE TRUE FALSE FALSE #> year classif.ce features n_features #> #> 1: FALSE 0.09210526 bill_depth,bill_length,island,sex 4 #> 2: FALSE 0.03947368 bill_length,flipper_length 2 #> 3: TRUE 0.06493506 bill_length,body_mass,flipper_length,year 4 #> task_id learner_id resampling_id #> #> 1: penguins classif.rpart.fselector cv #> 2: penguins classif.rpart.fselector cv #> 3: penguins classif.rpart.fselector cv # performance scores estimated on the outer resampling rr$score() #> task_id learner_id resampling_id iteration classif.ce #> #> 1: penguins classif.rpart.fselector cv 1 0.06086957 #> 2: penguins classif.rpart.fselector cv 2 0.05217391 #> 3: penguins classif.rpart.fselector cv 3 0.07894737 #> Hidden columns: task, learner, resampling, prediction_test # unbiased performance of the final model trained on the full data set rr$aggregate() #> classif.ce #> 0.06399695 # }"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/CallbackBatchFSelect.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Feature Selection Callback — CallbackBatchFSelect","title":"Create Feature Selection Callback — CallbackBatchFSelect","text":"Specialized bbotk::CallbackBatch feature selection. Callbacks allow customizing behavior processes mlr3fselect. callback_batch_fselect() function creates CallbackBatchFSelect. Predefined callbacks stored dictionary mlr_callbacks can retrieved clbk(). information callbacks see callback_batch_fselect().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/CallbackBatchFSelect.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"Create Feature Selection Callback — CallbackBatchFSelect","text":"mlr3misc::Callback -> bbotk::CallbackBatch -> CallbackBatchFSelect","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/CallbackBatchFSelect.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Create Feature Selection Callback — CallbackBatchFSelect","text":"on_eval_after_design (function()) Stage called design created. Called ObjectiveFSelectBatch$eval_many(). on_eval_after_benchmark (function()) Stage called feature sets evaluated. Called ObjectiveFSelectBatch$eval_many(). on_eval_before_archive (function()) Stage called performance values written archive. Called ObjectiveFSelectBatch$eval_many(). on_auto_fselector_before_final_model (function()) Stage called final model trained. Called AutoFSelector$train(). stage called optimization finished final model trained best feature set found. on_auto_fselector_after_final_model (function()) Stage called final model trained. Called AutoFSelector$train(). stage called final model trained best feature set found.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/CallbackBatchFSelect.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Create Feature Selection Callback — CallbackBatchFSelect","text":"mlr3misc::Callback$call() mlr3misc::Callback$format() mlr3misc::Callback$help() mlr3misc::Callback$initialize() mlr3misc::Callback$print()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/CallbackBatchFSelect.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Create Feature Selection Callback — CallbackBatchFSelect","text":"CallbackBatchFSelect$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/CallbackBatchFSelect.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Create Feature Selection Callback — CallbackBatchFSelect","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/CallbackBatchFSelect.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Feature Selection Callback — CallbackBatchFSelect","text":"","code":"CallbackBatchFSelect$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/CallbackBatchFSelect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Feature Selection Callback — CallbackBatchFSelect","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/CallbackBatchFSelect.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create Feature Selection Callback — CallbackBatchFSelect","text":"","code":"# Write archive to disk callback_batch_fselect(\"mlr3fselect.backup\", on_optimization_end = function(callback, context) { saveRDS(context$instance$archive, \"archive.rds\") } ) #> #> * Active Stages: on_optimization_end"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":null,"dir":"Reference","previous_headings":"","what":"Evaluation Context — ContextBatchFSelect","title":"Evaluation Context — ContextBatchFSelect","text":"ContextBatchFSelect allows CallbackBatchFSelects access modify data batch feature sets evaluated. See section active bindings list modifiable objects. See callback_batch_fselect() list stages access ContextBatchFSelect.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Evaluation Context — ContextBatchFSelect","text":"context re-created time new batch feature sets evaluated. Changes $objective_fselect, $design $benchmark_result discarded function finished. Modification data table $aggregated_performance written archive. number columns can added.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"Evaluation Context — ContextBatchFSelect","text":"mlr3misc::Context -> bbotk::ContextBatch -> ContextBatchFSelect","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Evaluation Context — ContextBatchFSelect","text":"auto_fselector (AutoFSelector) AutoFSelector instance.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Evaluation Context — ContextBatchFSelect","text":"xss (list()) feature sets latest batch. design (data.table::data.table) benchmark design latest batch. benchmark_result (mlr3::BenchmarkResult) benchmark result latest batch. aggregated_performance (data.table::data.table) Aggregated performance scores training time latest batch. data table passed archive. callback can add additional columns also written archive.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Evaluation Context — ContextBatchFSelect","text":"mlr3misc::Context$format() mlr3misc::Context$print() bbotk::ContextBatch$initialize()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Evaluation Context — ContextBatchFSelect","text":"ContextBatchFSelect$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Evaluation Context — ContextBatchFSelect","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Evaluation Context — ContextBatchFSelect","text":"","code":"ContextBatchFSelect$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ContextBatchFSelect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Evaluation Context — ContextBatchFSelect","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":null,"dir":"Reference","previous_headings":"","what":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"FSelectInstanceBatchMultiCrit specifies feature selection problem FSelector. function fsi() creates FSelectInstanceBatchMultiCrit function fselect() creates instance internally.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"resources","dir":"Reference","previous_headings":"","what":"Resources","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"several sections feature selection mlr3book. Learn multi-objective optimization. gallery features collection case studies demos optimization.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"analysis","dir":"Reference","previous_headings":"","what":"Analysis","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"analyzing feature selection results, recommended pass archive .data.table(). returned data table joined benchmark result adds mlr3::ResampleResult feature set. archive provides various getters (e.g. $learners()) ease access. getters extract position () unique hash (uhash). complete list getters see methods section. benchmark result ($benchmark_result) allows score feature sets different measure. Alternatively, measures can supplied .data.table().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"bbotk::OptimInstance -> bbotk::OptimInstanceBatch -> bbotk::OptimInstanceBatchMultiCrit -> FSelectInstanceBatchMultiCrit","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"result_feature_set (list character()) Feature sets task subsetting.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"bbotk::OptimInstance$clear() bbotk::OptimInstance$format() bbotk::OptimInstanceBatch$eval_batch() bbotk::OptimInstanceBatch$objective_function()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"FSelectInstanceBatchMultiCrit$new() FSelectInstanceBatchMultiCrit$assign_result() FSelectInstanceBatchMultiCrit$print() FSelectInstanceBatchMultiCrit$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"","code":"FSelectInstanceBatchMultiCrit$new( task, learner, resampling, measures, terminator, store_benchmark_result = TRUE, store_models = FALSE, check_values = FALSE, callbacks = NULL )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"task (mlr3::Task) Task operate . learner (mlr3::Learner) Learner optimize feature subset . resampling (mlr3::Resampling) Resampling used evaluated performance feature subsets. Uninstantiated resamplings instantiated construction feature subsets evaluated data splits. Already instantiated resamplings kept unchanged. measures (list mlr3::Measure) Measures optimize. NULL, mlr3's default measure used. terminator (bbotk::Terminator) Stop criterion feature selection. store_benchmark_result (logical(1)) Store benchmark result archive? store_models (logical(1)). Store models benchmark result? check_values (logical(1)) Check parameters evaluation results validity? callbacks (list CallbackBatchFSelect) List callbacks.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"method-assign-result-","dir":"Reference","previous_headings":"","what":"Method assign_result()","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"FSelector object writes best found feature subsets estimated performance values . internal use.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"","code":"FSelectInstanceBatchMultiCrit$assign_result(xdt, ydt, extra = NULL, ...)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"xdt (data.table::data.table()) x values data.table. row one point. Contains value search space FSelectInstanceBatchMultiCrit object. Can contain additional columns extra information. ydt (data.table::data.table()) Optimal outcomes, e.g. Pareto front. extra (data.table::data.table()) Additional information. ... () ignored.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"Printer.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"","code":"FSelectInstanceBatchMultiCrit$print(...)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"... (ignored).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"","code":"FSelectInstanceBatchMultiCrit$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchMultiCrit.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Class for Multi Criteria Feature Selection — FSelectInstanceBatchMultiCrit","text":"","code":"# Feature selection on Palmer Penguins data set # \\donttest{ task = tsk(\"penguins\") # Construct feature selection instance instance = fsi( task = task, learner = lrn(\"classif.rpart\"), resampling = rsmp(\"cv\", folds = 3), measures = msrs(c(\"classif.ce\", \"time_train\")), terminator = trm(\"evals\", n_evals = 4) ) # Choose optimization algorithm fselector = fs(\"random_search\", batch_size = 2) # Run feature selection fselector$optimize(instance) #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 2: FALSE FALSE FALSE TRUE FALSE FALSE FALSE #> features n_features #> #> 1: bill_depth,bill_length,body_mass,flipper_length,island,sex,... 7 #> 2: flipper_length 7 #> classif.ce time_train #> #> 1: 0.07261632 0.002666667 #> 2: 0.19471142 0.002333333 # Optimal feature sets instance$result_feature_set #> [[1]] #> [1] \"bill_depth\" \"bill_length\" \"body_mass\" \"flipper_length\" #> [5] \"island\" \"sex\" \"year\" #> #> [[2]] #> [1] \"flipper_length\" #> # Inspect all evaluated sets as.data.table(instance$archive) #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 2: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 3: FALSE TRUE FALSE FALSE FALSE FALSE FALSE #> 4: FALSE FALSE FALSE TRUE FALSE FALSE FALSE #> classif.ce time_train runtime_learners timestamp batch_nr #> #> 1: 0.07261632 0.002666667 0.015 2024-10-25 18:43:37 1 #> 2: 0.07261632 0.002666667 0.015 2024-10-25 18:43:37 1 #> 3: 0.25858124 0.002666667 0.013 2024-10-25 18:43:37 2 #> 4: 0.19471142 0.002333333 0.012 2024-10-25 18:43:37 2 #> warnings errors #> #> 1: 0 0 #> 2: 0 0 #> 3: 0 0 #> 4: 0 0 #> features n_features #> #> 1: bill_depth,bill_length,body_mass,flipper_length,island,sex,... 7 #> 2: bill_depth,bill_length,body_mass,flipper_length,island,sex,... 7 #> 3: bill_length 1 #> 4: flipper_length 1 #> resample_result #> #> 1: #> 2: #> 3: #> 4: # }"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":null,"dir":"Reference","previous_headings":"","what":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"FSelectInstanceBatchSingleCrit specifies feature selection problem FSelector. function fsi() creates FSelectInstanceBatchSingleCrit function fselect() creates instance internally. instance contains ObjectiveFSelectBatch object encodes black box objective function FSelector optimize. instance allows basic operations querying objective design points ($eval_batch()). operation usually done FSelector. Evaluations feature subsets performed batches calling mlr3::benchmark() internally. evaluated feature subsets stored Archive ($archive). batch evaluated, bbotk::Terminator queried remaining budget. available budget exhausted, exception raised, evaluations can performed point . FSelector also supposed store final result, consisting selected feature subset associated estimated performance values, calling method instance$assign_result().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"default-measures","dir":"Reference","previous_headings":"","what":"Default Measures","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"measure passed, default measure used. default measure depends task type.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"resources","dir":"Reference","previous_headings":"","what":"Resources","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"several sections feature selection mlr3book. Getting started wrapper feature selection. sequential forward selection Palmer Penguins data set. gallery features collection case studies demos optimization. Utilize built-feature importance models Recursive Feature Elimination. Run feature selection Shadow Variable Search. Feature Selection Titanic data set.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"analysis","dir":"Reference","previous_headings":"","what":"Analysis","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"analyzing feature selection results, recommended pass archive .data.table(). returned data table joined benchmark result adds mlr3::ResampleResult feature set. archive provides various getters (e.g. $learners()) ease access. getters extract position () unique hash (uhash). complete list getters see methods section. benchmark result ($benchmark_result) allows score feature sets different measure. Alternatively, measures can supplied .data.table().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"bbotk::OptimInstance -> bbotk::OptimInstanceBatch -> bbotk::OptimInstanceBatchSingleCrit -> FSelectInstanceBatchSingleCrit","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"result_feature_set (character()) Feature set task subsetting.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"bbotk::OptimInstance$clear() bbotk::OptimInstance$format() bbotk::OptimInstanceBatch$eval_batch() bbotk::OptimInstanceBatch$objective_function()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"FSelectInstanceBatchSingleCrit$new() FSelectInstanceBatchSingleCrit$assign_result() FSelectInstanceBatchSingleCrit$print() FSelectInstanceBatchSingleCrit$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"","code":"FSelectInstanceBatchSingleCrit$new( task, learner, resampling, measure, terminator, store_benchmark_result = TRUE, store_models = FALSE, check_values = FALSE, callbacks = NULL, ties_method = \"least_features\" )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"task (mlr3::Task) Task operate . learner (mlr3::Learner) Learner optimize feature subset . resampling (mlr3::Resampling) Resampling used evaluated performance feature subsets. Uninstantiated resamplings instantiated construction feature subsets evaluated data splits. Already instantiated resamplings kept unchanged. measure (mlr3::Measure) Measure optimize. NULL, default measure used. terminator (bbotk::Terminator) Stop criterion feature selection. store_benchmark_result (logical(1)) Store benchmark result archive? store_models (logical(1)). Store models benchmark result? check_values (logical(1)) Check parameters evaluation results validity? callbacks (list CallbackBatchFSelect) List callbacks. ties_method (character(1)) method break ties selecting sets optimizing selecting best set. Can \"least_features\" \"random\". option \"least_features\" (default) selects feature set least features. multiple best feature sets number features, one selected randomly. random method returns random feature set best feature sets. Ignored multiple measures used.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"method-assign-result-","dir":"Reference","previous_headings":"","what":"Method assign_result()","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"FSelector writes best found feature subset estimated performance value . internal use.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"","code":"FSelectInstanceBatchSingleCrit$assign_result(xdt, y, extra = NULL, ...)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"xdt (data.table::data.table()) x values data.table. row one point. Contains value search space FSelectInstanceBatchMultiCrit object. Can contain additional columns extra information. y (numeric(1)) Optimal outcome. extra (data.table::data.table()) Additional information. ... () ignored.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"Printer.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"","code":"FSelectInstanceBatchSingleCrit$print(...)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"... (ignored).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"","code":"FSelectInstanceBatchSingleCrit$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectInstanceBatchSingleCrit.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Class for Single Criterion Feature Selection — FSelectInstanceBatchSingleCrit","text":"","code":"# Feature selection on Palmer Penguins data set # \\donttest{ task = tsk(\"penguins\") learner = lrn(\"classif.rpart\") # Construct feature selection instance instance = fsi( task = task, learner = learner, resampling = rsmp(\"cv\", folds = 3), measures = msr(\"classif.ce\"), terminator = trm(\"evals\", n_evals = 4) ) # Choose optimization algorithm fselector = fs(\"random_search\", batch_size = 2) # Run feature selection fselector$optimize(instance) #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE TRUE TRUE TRUE TRUE FALSE #> features n_features #> #> 1: bill_depth,bill_length,body_mass,flipper_length,island,sex 6 #> classif.ce #> #> 1: 0.06112382 # Subset task to optimal feature set task$select(instance$result_feature_set) # Train the learner with optimal feature set on the full data set learner$train(task) # Inspect all evaluated sets as.data.table(instance$archive) #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE FALSE FALSE TRUE TRUE TRUE TRUE #> 2: FALSE FALSE FALSE TRUE FALSE TRUE TRUE #> 3: TRUE TRUE TRUE TRUE TRUE TRUE FALSE #> 4: TRUE FALSE FALSE TRUE FALSE FALSE TRUE #> classif.ce runtime_learners timestamp batch_nr warnings errors #> #> 1: 0.15400458 0.014 2024-10-25 18:43:38 1 0 0 #> 2: 0.19768624 0.015 2024-10-25 18:43:38 1 0 0 #> 3: 0.06112382 0.016 2024-10-25 18:43:38 2 0 0 #> 4: 0.18893974 0.013 2024-10-25 18:43:38 2 0 0 #> features n_features #> #> 1: bill_depth,flipper_length,island,sex,year 5 #> 2: flipper_length,sex,year 3 #> 3: bill_depth,bill_length,body_mass,flipper_length,island,sex 6 #> 4: bill_depth,flipper_length,year 3 #> resample_result #> #> 1: #> 2: #> 3: #> 4: # }"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":null,"dir":"Reference","previous_headings":"","what":"FSelector — FSelector","title":"FSelector — FSelector","text":"`FSelector“ implements optimization algorithm.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"FSelector — FSelector","text":"FSelector abstract base class implements base functionality fselector must provide.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"resources","dir":"Reference","previous_headings":"","what":"Resources","title":"FSelector — FSelector","text":"several sections feature selection mlr3book. Learn fselectors. gallery features collection case studies demos optimization. Utilize built-feature importance models Recursive Feature Elimination. Run feature selection Shadow Variable Search.","code":""},{"path":[]},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"FSelector — FSelector","text":"id (character(1)) Identifier object. Used tables, plot text output.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"FSelector — FSelector","text":"param_set paradox::ParamSet Set control parameters. properties (character()) Set properties fselector. Must subset mlr_reflections$fselect_properties. packages (character()) Set required packages. Note packages loaded via requireNamespace(), attached. label (character(1)) Label object. Can used tables, plot text output instead ID. man (character(1)) String format [pkg]::[topic] pointing manual page object. referenced help package can opened via method $help().","code":""},{"path":[]},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"FSelector — FSelector","text":"FSelector$new() FSelector$format() FSelector$print() FSelector$help() FSelector$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"FSelector — FSelector","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"FSelector — FSelector","text":"","code":"FSelector$new( id = \"fselector\", param_set, properties, packages = character(), label = NA_character_, man = NA_character_ )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"FSelector — FSelector","text":"id (character(1)) Identifier new instance. param_set paradox::ParamSet Set control parameters. properties (character()) Set properties fselector. Must subset mlr_reflections$fselect_properties. packages (character()) Set required packages. Note packages loaded via requireNamespace(), attached. label (character(1)) Label object. Can used tables, plot text output instead ID. man (character(1)) String format [pkg]::[topic] pointing manual page object. referenced help package can opened via method $help().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"method-format-","dir":"Reference","previous_headings":"","what":"Method format()","title":"FSelector — FSelector","text":"Helper print outputs.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"FSelector — FSelector","text":"","code":"FSelector$format(...)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"FSelector — FSelector","text":"... (ignored).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"FSelector — FSelector","text":"(character()).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"FSelector — FSelector","text":"Print method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"FSelector — FSelector","text":"","code":"FSelector$print()"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"FSelector — FSelector","text":"(character()).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"method-help-","dir":"Reference","previous_headings":"","what":"Method help()","title":"FSelector — FSelector","text":"Opens corresponding help page referenced field $man.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"FSelector — FSelector","text":"","code":"FSelector$help()"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"FSelector — FSelector","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"FSelector — FSelector","text":"","code":"FSelector$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelector.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"FSelector — FSelector","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":null,"dir":"Reference","previous_headings":"","what":"Class for Batch Feature Selection Algorithms — FSelectorBatch","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"FSelectorBatch implements optimization algorithm.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"FSelectorBatch abstract base class implements base functionality fselector must provide. subclass implemented following way: Inherit FSelectorBatch. Specify private abstract method $.optimize() use call optimizer. need call instance$eval_batch() evaluate design points. batch evaluation requested FSelectInstanceBatchSingleCrit/FSelectInstanceBatchMultiCrit object instance, batch possibly executed parallel via mlr3::benchmark(), evaluations stored inside instance$archive. batch evaluation, bbotk::Terminator checked, positive, exception class \"terminated_error\" generated. latter case current batch evaluations still stored instance, numeric scores sent back handling optimizer lost execution control. exception caught select best set instance$archive return . Note therefore points specified bbotk::Terminator may evaluated, Terminator checked batch evaluation, -evaluation batch. many depends setting batch size. Overwrite private super-method .assign_result() want decide estimate final set instance estimated performance. default behavior : pick best resample experiment, regarding given measure, assign set aggregated performance instance.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"private-methods","dir":"Reference","previous_headings":"","what":"Private Methods","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":".optimize(instance) -> NULL Abstract base method. Implement specify feature selection subclass. See technical details sections. .assign_result(instance) -> NULL Abstract base method. Implement specify final feature subset selected. See technical details sections.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"resources","dir":"Reference","previous_headings":"","what":"Resources","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"several sections feature selection mlr3book. Learn fselectors. gallery features collection case studies demos optimization. Utilize built-feature importance models Recursive Feature Elimination. Run feature selection Shadow Variable Search.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"mlr3fselect::FSelector -> FSelectorBatch","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"mlr3fselect::FSelector$format() mlr3fselect::FSelector$help() mlr3fselect::FSelector$print()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"FSelectorBatch$new() FSelectorBatch$optimize() FSelectorBatch$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"","code":"FSelectorBatch$new( id = \"fselector_batch\", param_set, properties, packages = character(), label = NA_character_, man = NA_character_ )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"id (character(1)) Identifier new instance. param_set paradox::ParamSet Set control parameters. properties (character()) Set properties fselector. Must subset mlr_reflections$fselect_properties. packages (character()) Set required packages. Note packages loaded via requireNamespace(), attached. label (character(1)) Label object. Can used tables, plot text output instead ID. man (character(1)) String format [pkg]::[topic] pointing manual page object. referenced help package can opened via method $help().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"method-optimize-","dir":"Reference","previous_headings":"","what":"Method optimize()","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"Performs feature selection FSelectInstanceBatchSingleCrit FSelectInstanceBatchMultiCrit termination. single evaluations written ArchiveBatchFSelect resides FSelectInstanceBatchSingleCrit / FSelectInstanceBatchMultiCrit. result written instance object.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"","code":"FSelectorBatch$optimize(inst)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"inst (FSelectInstanceBatchSingleCrit | FSelectInstanceBatchMultiCrit).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"data.table::data.table().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"","code":"FSelectorBatch$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatch.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Batch Feature Selection Algorithms — FSelectorBatch","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":null,"dir":"Reference","previous_headings":"","what":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"Internally used transform bbotk::Optimizer FSelector.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"mlr3fselect::FSelector -> mlr3fselect::FSelectorBatch -> FSelectorBatchFromOptimizerBatch","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"mlr3fselect::FSelector$format() mlr3fselect::FSelector$help() mlr3fselect::FSelector$print()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"FSelectorBatchFromOptimizerBatch$new() FSelectorBatchFromOptimizerBatch$optimize() FSelectorBatchFromOptimizerBatch$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"","code":"FSelectorBatchFromOptimizerBatch$new(optimizer, man = NA_character_)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"optimizer bbotk::Optimizer Optimizer called. man (character(1)) String format [pkg]::[topic] pointing manual page object. referenced help package can opened via method $help().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"method-optimize-","dir":"Reference","previous_headings":"","what":"Method optimize()","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"Performs feature selection FSelectInstanceBatchSingleCrit / FSelectInstanceBatchMultiCrit termination.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"","code":"FSelectorBatchFromOptimizerBatch$optimize(inst)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"inst (FSelectInstanceBatchSingleCrit | FSelectInstanceBatchMultiCrit).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"data.table::data.table.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"","code":"FSelectorBatchFromOptimizerBatch$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/FSelectorBatchFromOptimizerBatch.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"FSelectorBatchFromOptimizerBatch — FSelectorBatchFromOptimizerBatch","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":null,"dir":"Reference","previous_headings":"","what":"Class for Feature Selection Objective — ObjectiveFSelect","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"Stores objective function estimates performance feature subsets. class usually constructed internally FSelectInstanceBatchSingleCrit / FSelectInstanceBatchMultiCrit.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"bbotk::Objective -> ObjectiveFSelect","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"task (mlr3::Task). learner (mlr3::Learner). resampling (mlr3::Resampling). measures (list mlr3::Measure). store_models (logical(1)). store_benchmark_result (logical(1)). callbacks (List CallbackBatchFSelects).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"bbotk::Objective$eval() bbotk::Objective$eval_dt() bbotk::Objective$eval_many() bbotk::Objective$format() bbotk::Objective$help() bbotk::Objective$print()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"ObjectiveFSelect$new() ObjectiveFSelect$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"","code":"ObjectiveFSelect$new( task, learner, resampling, measures, check_values = TRUE, store_benchmark_result = TRUE, store_models = FALSE, callbacks = NULL )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"task (mlr3::Task) Task operate . learner (mlr3::Learner) Learner optimize feature subset . resampling (mlr3::Resampling) Resampling used evaluated performance feature subsets. Uninstantiated resamplings instantiated construction feature subsets evaluated data splits. Already instantiated resamplings kept unchanged. measures (list mlr3::Measure) Measures optimize. NULL, mlr3's default measure used. check_values (logical(1)) Check parameters evaluation results validity? store_benchmark_result (logical(1)) Store benchmark result archive? store_models (logical(1)). Store models benchmark result? callbacks (list CallbackBatchFSelect) List callbacks.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"","code":"ObjectiveFSelect$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelect.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Feature Selection Objective — ObjectiveFSelect","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":null,"dir":"Reference","previous_headings":"","what":"Class for Feature Selection Objective — ObjectiveFSelectBatch","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"Stores objective function estimates performance feature subsets. class usually constructed internally FSelectInstanceBatchSingleCrit / FSelectInstanceBatchMultiCrit.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"bbotk::Objective -> mlr3fselect::ObjectiveFSelect -> ObjectiveFSelectBatch","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"archive (ArchiveBatchFSelect).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"bbotk::Objective$eval() bbotk::Objective$eval_dt() bbotk::Objective$eval_many() bbotk::Objective$format() bbotk::Objective$help() bbotk::Objective$print()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"ObjectiveFSelectBatch$new() ObjectiveFSelectBatch$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"","code":"ObjectiveFSelectBatch$new( task, learner, resampling, measures, check_values = TRUE, store_benchmark_result = TRUE, store_models = FALSE, archive = NULL, callbacks = NULL )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"task (mlr3::Task) Task operate . learner (mlr3::Learner) Learner optimize feature subset . resampling (mlr3::Resampling) Resampling used evaluated performance feature subsets. Uninstantiated resamplings instantiated construction feature subsets evaluated data splits. Already instantiated resamplings kept unchanged. measures (list mlr3::Measure) Measures optimize. NULL, mlr3's default measure used. check_values (logical(1)) Check parameters evaluation results validity? store_benchmark_result (logical(1)) Store benchmark result archive? store_models (logical(1)). Store models benchmark result? archive (ArchiveBatchFSelect) Reference archive FSelectInstanceBatchSingleCrit | FSelectInstanceBatchMultiCrit. NULL (default), benchmark result models stored. callbacks (list CallbackBatchFSelect) List callbacks.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"","code":"ObjectiveFSelectBatch$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ObjectiveFSelectBatch.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class for Feature Selection Objective — ObjectiveFSelectBatch","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/auto_fselector.html","id":null,"dir":"Reference","previous_headings":"","what":"Function for Automatic Feature Selection — auto_fselector","title":"Function for Automatic Feature Selection — auto_fselector","text":"AutoFSelector wraps mlr3::Learner augments automatic feature selection. auto_fselector() function creates AutoFSelector object.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/auto_fselector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Function for Automatic Feature Selection — auto_fselector","text":"","code":"auto_fselector( fselector, learner, resampling, measure = NULL, term_evals = NULL, term_time = NULL, terminator = NULL, store_fselect_instance = TRUE, store_benchmark_result = TRUE, store_models = FALSE, check_values = FALSE, callbacks = NULL, ties_method = \"least_features\" )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/auto_fselector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Function for Automatic Feature Selection — auto_fselector","text":"fselector (FSelector) Optimization algorithm. learner (mlr3::Learner) Learner optimize feature subset . resampling (mlr3::Resampling) Resampling used evaluated performance feature subsets. Uninstantiated resamplings instantiated construction feature subsets evaluated data splits. Already instantiated resamplings kept unchanged. measure (mlr3::Measure) Measure optimize. NULL, default measure used. term_evals (integer(1)) Number allowed evaluations. Ignored terminator passed. term_time (integer(1)) Maximum allowed time seconds. Ignored terminator passed. terminator (bbotk::Terminator) Stop criterion feature selection. store_fselect_instance (logical(1)) TRUE (default), stores internally created FSelectInstanceBatchSingleCrit intermediate results slot $fselect_instance. set TRUE, store_models = TRUE store_benchmark_result (logical(1)) Store benchmark result archive? store_models (logical(1)). Store models benchmark result? check_values (logical(1)) Check parameters evaluation results validity? callbacks (list CallbackBatchFSelect) List callbacks. ties_method (character(1)) method break ties selecting sets optimizing selecting best set. Can \"least_features\" \"random\". option \"least_features\" (default) selects feature set least features. multiple best feature sets number features, one selected randomly. random method returns random feature set best feature sets. Ignored multiple measures used.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/auto_fselector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Function for Automatic Feature Selection — auto_fselector","text":"AutoFSelector.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/auto_fselector.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Function for Automatic Feature Selection — auto_fselector","text":"AutoFSelector mlr3::Learner wraps another mlr3::Learner performs following steps $train(): wrapped (inner) learner trained feature subsets via resampling. feature selection can specified providing FSelector, bbotk::Terminator, mlr3::Resampling mlr3::Measure. final model fit complete training data best-found feature subset. $predict() AutoFSelector just calls predict method wrapped (inner) learner.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/auto_fselector.html","id":"resources","dir":"Reference","previous_headings":"","what":"Resources","title":"Function for Automatic Feature Selection — auto_fselector","text":"several sections feature selection mlr3book. Estimate Model Performance nested resampling. gallery features collection case studies demos optimization.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/auto_fselector.html","id":"nested-resampling","dir":"Reference","previous_headings":"","what":"Nested Resampling","title":"Function for Automatic Feature Selection — auto_fselector","text":"Nested resampling can performed passing AutoFSelector object mlr3::resample() mlr3::benchmark(). access inner resampling results, set store_fselect_instance = TRUE execute mlr3::resample() mlr3::benchmark() store_models = TRUE (see examples). mlr3::Resampling passed AutoFSelector meant inner resampling, operating training set arbitrary outer resampling. reason feasible pass instantiated mlr3::Resampling .","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/auto_fselector.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Function for Automatic Feature Selection — auto_fselector","text":"","code":"# Automatic Feature Selection # \\donttest{ # split to train and external set task = tsk(\"penguins\") split = partition(task, ratio = 0.8) # create auto fselector afs = auto_fselector( fselector = fs(\"random_search\"), learner = lrn(\"classif.rpart\"), resampling = rsmp (\"holdout\"), measure = msr(\"classif.ce\"), term_evals = 4) # optimize feature subset and fit final model afs$train(task, row_ids = split$train) # predict with final model afs$predict(task, row_ids = split$test) #> for 69 observations: #> row_ids truth response #> 12 Adelie Adelie #> 14 Adelie Adelie #> 20 Adelie Chinstrap #> --- --- --- #> 321 Chinstrap Chinstrap #> 331 Chinstrap Adelie #> 338 Chinstrap Chinstrap # show result afs$fselect_result #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE FALSE TRUE TRUE FALSE TRUE #> features n_features classif.ce #> #> 1: bill_depth,bill_length,flipper_length,island,year 5 0.07608696 # model slot contains trained learner and fselect instance afs$model #> $learner #> : Classification Tree #> * Model: rpart #> * Parameters: xval=0 #> * Packages: mlr3, rpart #> * Predict Types: [response], prob #> * Feature Types: logical, integer, numeric, factor, ordered #> * Properties: importance, missings, multiclass, selected_features, #> twoclass, weights #> #> $features #> [1] \"bill_depth\" \"bill_length\" \"flipper_length\" \"island\" #> [5] \"year\" #> #> $fselect_instance #> #> * State: Optimized #> * Objective: #> * Terminator: #> * Result: #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE FALSE TRUE TRUE FALSE TRUE #> classif.ce #> #> 1: 0.07608696 #> * Archive: #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 2: FALSE FALSE FALSE FALSE TRUE FALSE TRUE #> 3: FALSE TRUE TRUE FALSE FALSE TRUE TRUE #> 4: TRUE TRUE TRUE TRUE TRUE TRUE FALSE #> 5: TRUE FALSE FALSE FALSE FALSE TRUE FALSE #> 6: TRUE TRUE TRUE FALSE FALSE TRUE FALSE #> 7: FALSE FALSE FALSE TRUE TRUE TRUE FALSE #> 8: FALSE TRUE TRUE TRUE FALSE TRUE FALSE #> 9: FALSE TRUE TRUE TRUE FALSE FALSE FALSE #> 10: TRUE TRUE FALSE TRUE TRUE FALSE TRUE #> classif.ce #> #> 1: 0.07608696 #> 2: 0.32608696 #> 3: 0.10869565 #> 4: 0.07608696 #> 5: 0.22826087 #> 6: 0.15217391 #> 7: 0.21739130 #> 8: 0.10869565 #> 9: 0.10869565 #> 10: 0.07608696 #> # shortcut trained learner afs$learner #> : Classification Tree #> * Model: rpart #> * Parameters: xval=0 #> * Packages: mlr3, rpart #> * Predict Types: [response], prob #> * Feature Types: logical, integer, numeric, factor, ordered #> * Properties: importance, missings, multiclass, selected_features, #> twoclass, weights # shortcut fselect instance afs$fselect_instance #> #> * State: Optimized #> * Objective: #> * Terminator: #> * Result: #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE FALSE TRUE TRUE FALSE TRUE #> classif.ce #> #> 1: 0.07608696 #> * Archive: #> bill_depth bill_length body_mass flipper_length island sex year #> #> 1: TRUE TRUE TRUE TRUE TRUE TRUE TRUE #> 2: FALSE FALSE FALSE FALSE TRUE FALSE TRUE #> 3: FALSE TRUE TRUE FALSE FALSE TRUE TRUE #> 4: TRUE TRUE TRUE TRUE TRUE TRUE FALSE #> 5: TRUE FALSE FALSE FALSE FALSE TRUE FALSE #> 6: TRUE TRUE TRUE FALSE FALSE TRUE FALSE #> 7: FALSE FALSE FALSE TRUE TRUE TRUE FALSE #> 8: FALSE TRUE TRUE TRUE FALSE TRUE FALSE #> 9: FALSE TRUE TRUE TRUE FALSE FALSE FALSE #> 10: TRUE TRUE FALSE TRUE TRUE FALSE TRUE #> classif.ce #> #> 1: 0.07608696 #> 2: 0.32608696 #> 3: 0.10869565 #> 4: 0.07608696 #> 5: 0.22826087 #> 6: 0.15217391 #> 7: 0.21739130 #> 8: 0.10869565 #> 9: 0.10869565 #> 10: 0.07608696 # Nested Resampling afs = auto_fselector( fselector = fs(\"random_search\"), learner = lrn(\"classif.rpart\"), resampling = rsmp (\"holdout\"), measure = msr(\"classif.ce\"), term_evals = 4) resampling_outer = rsmp(\"cv\", folds = 3) rr = resample(task, afs, resampling_outer, store_models = TRUE) # retrieve inner feature selection results. extract_inner_fselect_results(rr) #> iteration bill_depth bill_length body_mass flipper_length island sex #> #> 1: 1 FALSE TRUE TRUE FALSE TRUE FALSE #> 2: 2 TRUE TRUE TRUE FALSE FALSE FALSE #> 3: 3 FALSE TRUE FALSE TRUE TRUE FALSE #> year classif.ce features n_features task_id #> #> 1: FALSE 0.03947368 bill_length,body_mass,island 3 penguins #> 2: TRUE 0.06578947 bill_depth,bill_length,body_mass,year 4 penguins #> 3: FALSE 0.03896104 bill_length,flipper_length,island 3 penguins #> learner_id resampling_id #> #> 1: classif.rpart.fselector cv #> 2: classif.rpart.fselector cv #> 3: classif.rpart.fselector cv # performance scores estimated on the outer resampling rr$score() #> task_id learner_id resampling_id iteration classif.ce #> #> 1: penguins classif.rpart.fselector cv 1 0.05217391 #> 2: penguins classif.rpart.fselector cv 2 0.06956522 #> 3: penguins classif.rpart.fselector cv 3 0.07894737 #> Hidden columns: task, learner, resampling, prediction_test # unbiased performance of the final model trained on the full data set rr$aggregate() #> classif.ce #> 0.0668955 # }"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/callback_batch_fselect.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Feature Selection Callback — callback_batch_fselect","title":"Create Feature Selection Callback — callback_batch_fselect","text":"Function create CallbackBatchFSelect. Predefined callbacks stored dictionary mlr_callbacks can retrieved clbk(). Feature selection callbacks can called different stages feature selection. stages prefixed on_*. on_auto_fselector_* stages available callback used AutoFSelector. See also section parameters information stages. feature selection callback works bbotk::ContextBatch ContextBatchFSelect.","code":"Start Automatic Feature Selection Start Feature Selection - on_optimization_begin Start FSelect Batch - on_optimizer_before_eval Start Evaluation - on_eval_after_design - on_eval_after_benchmark - on_eval_before_archive End Evaluation - on_optimizer_after_eval End FSelect Batch - on_result - on_optimization_end End Feature Selection - on_auto_fselector_before_final_model - on_auto_fselector_after_final_model End Automatic Feature Selection"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/callback_batch_fselect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Feature Selection Callback — callback_batch_fselect","text":"","code":"callback_batch_fselect( id, label = NA_character_, man = NA_character_, on_optimization_begin = NULL, on_optimizer_before_eval = NULL, on_eval_after_design = NULL, on_eval_after_benchmark = NULL, on_eval_before_archive = NULL, on_optimizer_after_eval = NULL, on_result = NULL, on_optimization_end = NULL, on_auto_fselector_before_final_model = NULL, on_auto_fselector_after_final_model = NULL )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/callback_batch_fselect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Feature Selection Callback — callback_batch_fselect","text":"id (character(1)) Identifier new instance. label (character(1)) Label new instance. man (character(1)) String format [pkg]::[topic] pointing manual page object. referenced help package can opened via method $help(). on_optimization_begin (function()) Stage called beginning optimization. Called Optimizer$optimize(). on_optimizer_before_eval (function()) Stage called optimizer proposes points. Called OptimInstance$eval_batch(). on_eval_after_design (function()) Stage called design created. Called ObjectiveFSelectBatch$eval_many(). on_eval_after_benchmark (function()) Stage called feature sets evaluated. Called ObjectiveFSelectBatch$eval_many(). on_eval_before_archive (function()) Stage called performance values written archive. Called ObjectiveFSelectBatch$eval_many(). on_optimizer_after_eval (function()) Stage called points evaluated. Called OptimInstance$eval_batch(). on_result (function()) Stage called result written. Called OptimInstance$assign_result(). on_optimization_end (function()) Stage called end optimization. Called Optimizer$optimize(). on_auto_fselector_before_final_model (function()) Stage called final model trained. Called AutoFSelector$train(). on_auto_fselector_after_final_model (function()) Stage called final model trained. Called AutoFSelector$train().","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/callback_batch_fselect.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create Feature Selection Callback — callback_batch_fselect","text":"implementing callback, function must two arguments named callback context. callback can write data state ($state), e.g. settings affect callback . Avoid writing large data state.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/callback_batch_fselect.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create Feature Selection Callback — callback_batch_fselect","text":"","code":"# Write archive to disk callback_batch_fselect(\"mlr3fselect.backup\", on_optimization_end = function(callback, context) { saveRDS(context$instance$archive, \"archive.rds\") } ) #> #> * Active Stages: on_optimization_end"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":null,"dir":"Reference","previous_headings":"","what":"Ensemble Feature Selection Result — ensemble_fs_result","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"EnsembleFSResult stores results ensemble feature selection. includes methods evaluating stability feature selection process ranking selected features among others. function ensemble_fselect() returns object class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"s-methods","dir":"Reference","previous_headings":"","what":"S3 Methods","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":".data.table.EnsembleFSResult(x, benchmark_result = TRUE) Returns tabular view ensemble feature selection. EnsembleFSResult -> data.table::data.table() x (EnsembleFSResult) benchmark_result (logical(1)) Whether add learner, task resampling information benchmark result.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"Das, (1999). “characterizing 'knee' Pareto curve based normal-boundary intersection.” Structural Optimization, 18(1-2), 107–115. ISSN 09344373.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"benchmark_result (mlr3::BenchmarkResult) benchmark result. man (character(1)) Manual page object.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"result (data.table::data.table) Returns result ensemble feature selection. n_learners (numeric(1)) Returns number learners used ensemble feature selection. measure (character(1)) Returns measure id used ensemble feature selection.","code":""},{"path":[]},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"EnsembleFSResult$new() EnsembleFSResult$format() EnsembleFSResult$print() EnsembleFSResult$help() EnsembleFSResult$feature_ranking() EnsembleFSResult$stability() EnsembleFSResult$pareto_front() EnsembleFSResult$knee_points() EnsembleFSResult$clone()","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"EnsembleFSResult$new( result, features, benchmark_result = NULL, measure_id, minimize = TRUE )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"result (data.table::data.table) result ensemble feature selection. Column names include \"resampling_iteration\", \"learner_id\", \"features\" \"n_features\". features (character()) vector features task used ensemble feature selection. benchmark_result (mlr3::BenchmarkResult) benchmark result object. measure_id (character(1)) Column name \"result\" corresponds measure used. minimize (logical(1)) TRUE (default), lower values measure correspond higher performance.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"method-format-","dir":"Reference","previous_headings":"","what":"Method format()","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"Helper print outputs.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"EnsembleFSResult$format(...)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"... (ignored).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"Printer.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"EnsembleFSResult$print(...)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"... (ignored).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"method-help-","dir":"Reference","previous_headings":"","what":"Method help()","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"Opens corresponding help page referenced field $man.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"EnsembleFSResult$help()"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"method-feature-ranking-","dir":"Reference","previous_headings":"","what":"Method feature_ranking()","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"Calculates feature ranking.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"EnsembleFSResult$feature_ranking(method = \"approval_voting\")"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"method (character(1)) method calculate feature ranking.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"feature ranking process built following framework: models act voters, features act candidates, voters select certain candidates (features). primary objective compile selections consensus ranked list features, effectively forming committee. Currently, \"approval_voting\" method supported, selects candidates/features highest approval score selection frequency, .e. appear often.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"data.table::data.table listing features, ordered decreasing inclusion probability scores (depending method)","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"method-stability-","dir":"Reference","previous_headings":"","what":"Method stability()","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"Calculates stability selected features stabm package. results cached. stability measure requested different arguments, cache must reset.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"EnsembleFSResult$stability( stability_measure = \"jaccard\", stability_args = NULL, global = TRUE, reset_cache = FALSE )"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"stability_measure (character(1)) stability measure used. One measures returned stabm::listStabilityMeasures() lower case. Default \"jaccard\". stability_args (list) Additional arguments passed stability measure function. global (logical(1)) Whether calculate stability globally learner. reset_cache (logical(1)) TRUE, cached results ignored.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"numeric() value representing stability selected features. numeric() vector stability selected features learner.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"method-pareto-front-","dir":"Reference","previous_headings":"","what":"Method pareto_front()","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"function identifies Pareto front ensemble feature selection process, .e., set points represent trade-number features performance (e.g. classification error).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"EnsembleFSResult$pareto_front(type = \"empirical\")"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"type (character(1)) Specifies type Pareto front return. See details.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"details-1","dir":"Reference","previous_headings":"","what":"Details","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"Two options available Pareto front: \"empirical\" (default): returns empirical Pareto front. \"estimated\": Pareto front points estimated fitting linear model inversed number features (\\(1/x\\)) input associated performance scores output. method useful Pareto points sparse front assumes convex shape better performance corresponds lower measure values (e.g. classification error), concave shape otherwise (e.g. classification accuracy). estimated Pareto front include points number features ranging 1 maximum number found empirical Pareto front.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"data.table::data.table columns number features performance together form Pareto front.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"method-knee-points-","dir":"Reference","previous_headings":"","what":"Method knee_points()","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"function implements various knee point identification (KPI) methods, select points Pareto front, optimal trade-performance number features achieved. cases, one point returned.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"EnsembleFSResult$knee_points(method = \"NBI\", type = \"empirical\")"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"method (character(1)) Type method use identify knee point. See details. type (character(1)) Specifies type Pareto front use identification knee point. See pareto_front() method details.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"details-2","dir":"Reference","previous_headings":"","what":"Details","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"available KPI methods : \"NBI\" (default): Normal-Boundary Intersection method geometry-based method calculates perpendicular distance point line connecting first last points Pareto front. knee point determined Pareto point maximum distance line, see Das (1999).","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"data.table::data.table knee point(s) Pareto front.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"objects class cloneable method.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"EnsembleFSResult$clone(deep = FALSE)"},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3fselect.mlr-org.com/dev/reference/ensemble_fs_result.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Ensemble Feature Selection Result — ensemble_fs_result","text":"","code":"# \\donttest{ efsr = ensemble_fselect( fselector = fs(\"rfe\", n_features = 2, feature_fraction = 0.8), task = tsk(\"sonar\"), learners = lrns(c(\"classif.rpart\", \"classif.featureless\")), init_resampling = rsmp(\"subsampling\", repeats = 2), inner_resampling = rsmp(\"cv\", folds = 3), measure = msr(\"classif.ce\"), terminator = trm(\"none\") ) # contains the benchmark result efsr$benchmark_result #> of 4 rows with 4 resampling runs #> nr task_id learner_id resampling_id iters warnings errors #> 1 sonar classif.rpart.fselector insample 1 0 0 #> 2 sonar classif.featureless.fselector insample 1 0 0 #> 3 sonar classif.rpart.fselector insample 1 0 0 #> 4 sonar classif.featureless.fselector insample 1 0 0 # contains the selected features for each iteration efsr$result #> resampling_iteration learner_id features #> #> 1: 1 classif.rpart V10,V11,V12,V13,V16,V17,... #> 2: 1 classif.featureless V27,V34 #> 3: 2 classif.rpart V11,V12,V16 #> 4: 2 classif.featureless V36,V54 #> n_features classif.ce #> #> 1: 12 0.2880049 #> 2: 2 0.4892075 #> 3: 3 0.2516189 #> 4: 2 0.4605304 #> importance #> #> 1: 12.000000, 9.666667, 9.666667, 7.666667, 7.000000, 6.666667,... #> 2: 2,1 #> 3: 2.333333,2.333333,1.333333 #> 4: 1.666667,1.333333 #> task learner #> #> 1: