refactor: pass extra information of the result in the extra parameter (…

…#458) * refactor: pass extra information of the result in the extra parameter * ... * ...
mlr-org · Oct 27, 2024 · 0d5e8f5 · 0d5e8f5
1 parent 89bc580
commit 0d5e8f5
Show file tree

Hide file tree

Showing 12 changed files with 94 additions and 38 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -29,7 +29,7 @@ Depends:
     paradox (>= 1.0.1),
     R (>= 3.1.0)
 Imports:
-    bbotk (>= 1.1.1),
+    bbotk (>= 1.2.0),
     checkmate (>= 2.0.0),
     data.table,
     lgr,

diff --git a/NEWS.md b/NEWS.md
@@ -1,11 +1,10 @@
 # mlr3tuning (development version)
 
 * fix: The `as_data_table()` functions do not unnest the `x_domain` colum anymore by default.
-* fix: `to_tune(internal = TRUE)` now also works if non-internal tuning parameters require have
-  an `.extra_trafo`
+* fix: `to_tune(internal = TRUE)` now also works if non-internal tuning parameters require have an `.extra_trafo`.
 * feat: It is now possible to pass an `internal_search_space` manually.
-  This allows to use parameter transformations on the primary search space in combination with
-  internal hyperparameter tuning.
+  This allows to use parameter transformations on the primary search space in combination with internal hyperparameter tuning.
+* refactor: The `Tuner` pass extra information of the result in the `extra` parameter now.
 
 # mlr3tuning 1.0.2
 

diff --git a/R/TuningInstanceAsyncMulticrit.R b/R/TuningInstanceAsyncMulticrit.R
@@ -26,6 +26,7 @@
 #' @template param_xdt
 #' @template param_learner_param_vals
 #' @template param_internal_tuned_values
+#' @template param_extra
 #'
 #' @template field_internal_search_space
 #'
@@ -147,13 +148,18 @@ TuningInstanceAsyncMultiCrit = R6Class("TuningInstanceAsyncMultiCrit",
     #' For internal use.
     #'
     #' @param ydt (`numeric(1)`)\cr
-    #'  Optimal outcomes, e.g. the Pareto front.
+    #' Optimal outcomes, e.g. the Pareto front.
     #' @param xydt (`data.table::data.table()`)\cr
-    #'   Point, outcome, and additional information.
-    assign_result = function(xdt, ydt, learner_param_vals = NULL, xydt = NULL) {
+    #' Point, outcome, and additional information.
+    #' @param ... (`any`)\cr
+    #' ignored.
+    assign_result = function(xdt, ydt, learner_param_vals = NULL, extra = NULL, xydt = NULL, ...) {
+      # workaround
+      extra = extra %??% xydt
+
       # extract internal tuned values
-      if ("internal_tuned_values" %in% names(xydt)) {
-        set(xdt, j = "internal_tuned_values", value = list(xydt[["internal_tuned_values"]]))
+      if ("internal_tuned_values" %in% names(extra)) {
+        set(xdt, j = "internal_tuned_values", value = list(extra[["internal_tuned_values"]]))
       }
 
       # set the column with the learner param_vals that were not optimized over but set implicitly

diff --git a/R/TuningInstanceAsyncSingleCrit.R b/R/TuningInstanceAsyncSingleCrit.R
@@ -36,6 +36,7 @@
 #' @template param_xdt
 #' @template param_learner_param_vals
 #' @template param_internal_tuned_values
+#' @template param_extra
 #'
 #' @template field_internal_search_space
 #'
@@ -159,14 +160,19 @@ TuningInstanceAsyncSingleCrit = R6Class("TuningInstanceAsyncSingleCrit",
     #' @param y (`numeric(1)`)\cr
     #' Optimal outcome.
     #' @param xydt (`data.table::data.table()`)\cr
-    #'   Point, outcome, and additional information.
-    assign_result = function(xdt, y, learner_param_vals = NULL, xydt = NULL) {
+    #' Point, outcome, and additional information (Deprecated).
+    #' @param ... (`any`)\cr
+    #' ignored.
+    assign_result = function(xdt, y, learner_param_vals = NULL, extra = NULL, xydt = NULL, ...) {
+      # workaround
+      extra = extra %??% xydt
+
       # set the column with the learner param_vals that were not optimized over but set implicitly
       assert_list(learner_param_vals, null.ok = TRUE, names = "named")
 
       # extract internal tuned values
-      if ("internal_tuned_values" %in% names(xydt)) {
-        set(xdt, j = "internal_tuned_values", value = list(xydt[["internal_tuned_values"]]))
+      if ("internal_tuned_values" %in% names(extra)) {
+        set(xdt, j = "internal_tuned_values", value = list(extra[["internal_tuned_values"]]))
       }
 
       if (is.null(learner_param_vals)) {

diff --git a/R/TuningInstanceBatchMulticrit.R b/R/TuningInstanceBatchMulticrit.R
@@ -33,6 +33,7 @@
 #' @template param_xdt
 #' @template param_learner_param_vals
 #' @template param_internal_tuned_values
+#' @template param_extra
 #'
 #' @template field_internal_search_space
 #'
@@ -181,13 +182,18 @@ TuningInstanceBatchMultiCrit = R6Class("TuningInstanceBatchMultiCrit",
     #' For internal use.
     #'
     #' @param ydt (`data.table::data.table()`)\cr
-    #'   Optimal outcomes, e.g. the Pareto front.
+    #' Optimal outcomes, e.g. the Pareto front.
     #' @param xydt (`data.table::data.table()`)\cr
-    #'   Point, outcome, and additional information.
-    assign_result = function(xdt, ydt, learner_param_vals = NULL, xydt = NULL) {
+    #' Point, outcome, and additional information (Deprecated).
+    #' @param ... (`any`)\cr
+    #' ignored.
+    assign_result = function(xdt, ydt, learner_param_vals = NULL, extra = NULL, xydt = NULL, ...) {
+      # workaround
+      extra = extra %??% xydt
+
       # extract internal tuned values
-      if ("internal_tuned_values" %in% names(xydt)) {
-        set(xdt, j = "internal_tuned_values", value = list(xydt[["internal_tuned_values"]]))
+      if ("internal_tuned_values" %in% names(extra)) {
+        set(xdt, j = "internal_tuned_values", value = list(extra[["internal_tuned_values"]]))
       }
 
       # set the column with the learner param_vals that were not optimized over but set implicitly

diff --git a/R/TuningInstanceBatchSingleCrit.R b/R/TuningInstanceBatchSingleCrit.R
@@ -68,6 +68,7 @@
 #' @template param_xdt
 #' @template param_learner_param_vals
 #' @template param_internal_tuned_values
+#' @template param_extra
 #'
 #' @template field_internal_search_space
 #'
@@ -219,17 +220,21 @@ TuningInstanceBatchSingleCrit = R6Class("TuningInstanceBatchSingleCrit",
     #' For internal use.
     #'
     #' @param y (`numeric(1)`)\cr
-    #'   Optimal outcome.
+    #' Optimal outcome.
     #' @param xydt (`data.table::data.table()`)\cr
-    #'   Point, outcome, and additional information.
-    assign_result = function(xdt, y, learner_param_vals = NULL, xydt = NULL) {
+    #' Point, outcome, and additional information (Deprecated).
+    #' @param ... (`any`)\cr
+    #' ignored.
+    assign_result = function(xdt, y, learner_param_vals = NULL, extra = NULL, xydt = NULL, ...) {
+      # workaround
+      extra = extra %??% xydt
 
       # set the column with the learner param_vals that were not optimized over but set implicitly
       assert_list(learner_param_vals, null.ok = TRUE, names = "named")
 
       # extract internal tuned values
-      if ("internal_tuned_values" %in% names(xydt)) {
-        set(xdt, j = "internal_tuned_values", value = list(xydt[["internal_tuned_values"]]))
+      if ("internal_tuned_values" %in% names(extra)) {
+        set(xdt, j = "internal_tuned_values", value = list(extra[["internal_tuned_values"]]))
       }
 
       # learner param values

diff --git a/man-roxygen/param_extra.R b/man-roxygen/param_extra.R
@@ -0,0 +1,2 @@
+#' @param extra (`data.table::data.table()`)\cr
+#' Additional information.
diff --git a/man/TuningInstanceAsyncMultiCrit.Rd b/man/TuningInstanceAsyncMultiCrit.Rd
diff --git a/man/TuningInstanceAsyncSingleCrit.Rd b/man/TuningInstanceAsyncSingleCrit.Rd
diff --git a/man/TuningInstanceBatchMultiCrit.Rd b/man/TuningInstanceBatchMultiCrit.Rd
diff --git a/man/TuningInstanceBatchSingleCrit.Rd b/man/TuningInstanceBatchSingleCrit.Rd
diff --git a/man/mlr_tuners_cmaes.Rd b/man/mlr_tuners_cmaes.Rd
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		#' @param extra (`data.table::data.table()`)\cr
		#' Additional information.