public methods

R/ResultData.R

@@ -250,7 +250,7 @@ ResultData = R6Class("ResultData",
         phash = self$data$fact[i, "learner_phash"][[1L]]
         learner = self$data$learners[phash, "learner", on = "learner_phash"][[1L]][[1L]]
         if (!is.null(state$model) && isFALSE(state$bundled)) {
-          state$model = get_private(learner)$.bundle(state$model)
+          state$model = learner$bundle_model(state$model)
           state$bundled = TRUE
         }
         state
@@ -266,7 +266,7 @@ ResultData = R6Class("ResultData",
         phash = self$data$fact[i, "learner_phash"][[1L]]
         learner = self$data$learners[phash, "learner", on = "learner_phash"][[1L]][[1L]]
         if (!is.null(state$model) && isTRUE(state$bundled)) {
-          state$model = get_private(learner)$.unbundle(state$model)
+          state$model = learner$unbundle_model(state$model)
           state$bundled = FALSE
         }
         state

R/bundle.R

@@ -23,11 +23,11 @@
 #' In order to implement bundling for a [`Learner`], you need to add:
 #' * the public methods `$bundle()` and `$unbundle()`, where you call `learner_bundle(self)` and
 #'   `learner_unbundle(self)` respectively.
-#' * the active binding `$bundled`, where you simply call `learner_bundled(self)`.
-#' * the private method `$.bundle(model)`, which takes in a [`Learner`]'s model and returns it in bundled form,
+#' * the public method `$bundle_model(model)`, which takes in a [`Learner`]'s model and returns it in bundled form,
 #'   without modifying the learner's state. Must not depend on the learner's state.
-#' * the private method `$.unbundle(model)`, which takes in a [`Learner`]'s bundled model and returns it in
+#' * the public method `$unbundle_model(model)`, which takes in a [`Learner`]'s bundled model and returns it in
 #'   unbundled form. Must not depend on the learner's state.
+#' * the active binding `$bundled`, where you simply call `learner_bundled(self)`.
 #' * add the property `bundle` to the learner's properties.
 #'
 #' To test the bundling implementation, you can use the internal test helper `expect_bundleable()`.
@@ -47,7 +47,7 @@ learner_unbundle = function(learner) {
   if (isFALSE(learner$bundled)) {
     warningf("Learner '%s' has not been bundled, skipping.", learner$id)
   } else if (isTRUE(learner$bundled)) {
-    learner$model = get_private(learner)$.unbundle(learner$model)
+    learner$model = learner$unbundle_model(learner$model)
     learner$state$bundled = FALSE
   }
   invisible(learner)
@@ -62,7 +62,7 @@ learner_bundle = function(learner) {
   if (isTRUE(learner$bundled)) {
     warningf("Learner '%s' has already been bundled, skipping.", learner$id)
   } else if ("bundle" %in% learner$properties) {
-    learner$model = get_private(learner)$.bundle(learner$model)
+    learner$model = learner$bundle_model(learner$model)
     learner$state$bundled = TRUE
   }
   invisible(learner)

R/worker.R

@@ -19,7 +19,7 @@ learner_train = function(learner, task, train_row_ids = NULL, test_row_ids = NUL
     }
 
     if ("bundle" %in% learner$properties && identical(learner$encapsulate[["train"]], "callr")) {
-      model = get_private(learner)$.bundle(model)
+      model = learner$bundle_model(model)
     }
 
     model

inst/testthat/helper_expectations.R

@@ -398,15 +398,12 @@ expect_bundleable = function(learner, task) {
   has_public = function(learner, x) {
     exists(x, learner, inherits = FALSE)
   }
-  has_private = function(learner, x) {
-    exists(x, mlr3misc::get_private(learner), inherits = FALSE)
-  }
 
   expect_true(has_public(learner, "bundle") && test_function(learner$bundle, nargs = 0))
   expect_true(has_public(learner, "unbundle") && test_function(learner$unbundle, nargs = 0))
   expect_true(has_public(learner, "bundle"))
-  expect_true(has_private(learner, ".bundle") && test_function(mlr3misc::get_private(learner)$.bundle, nargs = 1, args = "model"))
-  expect_true(has_private(learner, ".unbundle") && test_function(mlr3misc::get_private(learner)$.unbundle, nargs = 1, args = "model"))
+  expect_true(has_public(learner, "bundle_model") && test_function(learner$bundle_model, nargs = 1, args = "model"))
+  expect_true(has_public(learner, "unbundle_model") && test_function(learner$unbundle_model, nargs = 1, args = "model"))
 
   expect_false(learner$bundled)
 

tests/testthat/test_benchmark.R

@@ -493,6 +493,12 @@ test_that("bundling", {
       },
       unbundle = function() {
         learner_unbundle(self)
+      },
+      bundle_model = function(model) {
+        structure(list(model), class = private$.class)
+      },
+      unbundle_model = function(model) {
+        model[[1L]]
       }
     ),
     active = list(
@@ -501,12 +507,6 @@ test_that("bundling", {
       }
     ),
     private = list(
-      .bundle = function(model) {
-        structure(list(model), class = private$.class)
-      },
-      .unbundle = function(model) {
-        model[[1L]]
-      },
       .class = NULL
     )
   )

tests/testthat/test_bundle.R

@@ -13,19 +13,19 @@ test_that("bundleable learner behaves as expected", {
       },
       unbundle = function() {
         learner_unbundle(self)
-      }
-    ),
-    private = list(
-      .bundle = function(model) {
+      },
+      bundle_model = function(model) {
         private$.tmp_model = model
         "bundle"
       },
-      .unbundle = function(model) {
+      unbundle_model = function(model) {
         model = private$.tmp_model
         private$.tmp_model = NULL
         private$.counter = private$.counter + 1
         model
-      },
+      }
+    ),
+    private = list(
       .tmp_model = NULL,
       .counter = 0
     ),

tests/testthat/test_resample.R

@@ -167,18 +167,18 @@ test_that("bundling", {
         self$properties = c("bundle", self$properties)
       },
       bundle = function() learner_bundle(self),
-      unbundle = function() learner_unbundle(self)
+      unbundle = function() learner_unbundle(self),
+      bundle_model = function(model) {
+        structure(list(model), class = "bundled")
+      },
+      unbundle_model = function(model) {
+        model[[1L]]
+      }
     ),
     active = list(
       bundled = function() learner_bundled(self)
     ),
     private = list(
-      .bundle = function(model) {
-        structure(list(model), class = "bundled")
-      },
-      .unbundle = function(model) {
-        model[[1L]]
-      },
       .tmp_model = NULL
     )
   )