refactor: rename to batch classes

mlr-org · Jun 21, 2024 · 579ad41 · 579ad41
1 parent 7083f4e
commit 579ad41
Show file tree

Hide file tree

Showing 14 changed files with 119 additions and 119 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -54,10 +54,10 @@ Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.1
 Collate:
     'aaa.R'
-    'OptimizerSuccessiveHalving.R'
-    'OptimizerHyperband.R'
-    'TunerHyperband.R'
-    'TunerSuccessiveHalving.R'
+    'OptimizerBatchSuccessiveHalving.R'
+    'OptimizerBatchHyperband.R'
+    'TunerBatchHyperband.R'
+    'TunerBatchSuccessiveHalving.R'
     'bibentries.R'
     'helper.R'
     'zzz.R'
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,9 +1,9 @@
 # Generated by roxygen2: do not edit by hand
 
-export(OptimizerHyperband)
-export(OptimizerSuccessiveHalving)
-export(TunerHyperband)
-export(TunerSuccessiveHalving)
+export(OptimizerBatchHyperband)
+export(OptimizerBatchSuccessiveHalving)
+export(TunerBatchHyperband)
+export(TunerBatchSuccessiveHalving)
 export(hyperband_budget)
 export(hyperband_n_configs)
 export(hyperband_schedule)

diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,6 @@
 # mlr3hyperband (development version)
 
-* compatibility; Work with new bbotk 0.9.0 and mlr3tuning 0.21.0
+* compatibility; Work with new bbotk 1.0.0 and mlr3tuning 1.0.0
 
 # mlr3hyperband 0.5.0
 
@@ -14,7 +14,7 @@
 
 # mlr3hyperband 0.4.4
 
-* fix: Remove `emoa` from required packages of `OptimizerSuccessiveHalving`.
+* fix: Remove `emoa` from required packages of `OptimizerBatchSuccessiveHalving`.
 
 # mlr3hyperband 0.4.3
 
@@ -32,23 +32,23 @@
 
 # mlr3hyperband 0.4.0
 
-* feat: New `adjust_minimum_budget` flag in  `OptimizerSuccessiveHalving`. The
+* feat: New `adjust_minimum_budget` flag in  `OptimizerBatchSuccessiveHalving`. The
   minimum budget is adjusted in the base stage to use the maximum budget in last
   stage.
 * feat: New `repetitions` parameter to specify the exact number of repetitions.
   Replaced the `repeats` parameter.
 
 # mlr3hyperband 0.3.0
 
-* feat: `TunerHyperband` evaluates configurations of same budget across
+* feat: `TunerBatchHyperband` evaluates configurations of same budget across
   brackets in parallel now.
 * feat: New `repeats` parameter to repeat runs of successive halving and
   hyperband until termination.
 * fix: Bug where maximization measures were minimized.
 
 # mlr3hyperband 0.2.0
 
-* feat: New `OptimizerHyperband` and `OptimizerSuccessiveHalving` optimizers.
+* feat: New `OptimizerBatchHyperband` and `OptimizerBatchSuccessiveHalving` optimizers.
 
 # mlr3hyperband 0.1.2
 

diff --git a/R/OptimizerHyperband.R → R/OptimizerBatchHyperband.R b/R/OptimizerHyperband.R → R/OptimizerBatchHyperband.R
@@ -1,12 +1,12 @@
 #' @title Optimizer Using the Hyperband Algorithm
 
-#' @include OptimizerSuccessiveHalving.R
+#' @include OptimizerBatchSuccessiveHalving.R
 #' @name mlr_optimizers_hyperband
 #' @templateVar id hyperband
 #'
 #' @description
 #' Optimizer using the Hyperband (HB) algorithm.
-#' HB runs the [Successive Halving Algorithm][OptimizerSuccessiveHalving] (SHA) with different numbers of stating configurations.
+#' HB runs the [Successive Halving Algorithm][OptimizerBatchSuccessiveHalving] (SHA) with different numbers of stating configurations.
 #' The algorithm is initialized with the same parameters as Successive Halving but without `n`.
 #' Each run of Successive Halving is called a bracket and starts with a different budget `r_0`.
 #' A smaller starting budget means that more configurations can be tried out.
@@ -72,7 +72,7 @@
 #'
 #' @export
 #' @template example_optimizer
-OptimizerHyperband = R6Class("OptimizerHyperband",
+OptimizerBatchHyperband = R6Class("OptimizerBatchHyperband",
   inherit = OptimizerBatch,
   public = list(
 
@@ -199,4 +199,4 @@ OptimizerHyperband = R6Class("OptimizerHyperband",
 )
 
 #' @include aaa.R
-optimizers[["hyperband"]] = OptimizerHyperband
+optimizers[["hyperband"]] = OptimizerBatchHyperband
diff --git a/R/OptimizerSuccessiveHalving.R → R/OptimizerBatchSuccessiveHalving.R b/R/OptimizerSuccessiveHalving.R → R/OptimizerBatchSuccessiveHalving.R
@@ -65,7 +65,7 @@
 #'
 #' @export
 #' @template example_optimizer
-OptimizerSuccessiveHalving = R6Class("OptimizerSuccessiveHalving",
+OptimizerBatchSuccessiveHalving = R6Class("OptimizerBatchSuccessiveHalving",
   inherit = OptimizerBatch,
   public = list(
 
@@ -179,4 +179,4 @@ OptimizerSuccessiveHalving = R6Class("OptimizerSuccessiveHalving",
 )
 
 #' @include aaa.R
-optimizers[["successive_halving"]] = OptimizerSuccessiveHalving
+optimizers[["successive_halving"]] = OptimizerBatchSuccessiveHalving
diff --git a/R/TunerHyperband.R → R/TunerBatchHyperband.R b/R/TunerHyperband.R → R/TunerBatchHyperband.R
@@ -1,6 +1,6 @@
 #' @title Tuner Using the Hyperband Algorithm
 #'
-#' @include OptimizerHyperband.R
+#' @include OptimizerBatchHyperband.R
 #' @name mlr_tuners_hyperband
 #' @templateVar id hyperband
 #'
@@ -25,20 +25,20 @@
 #'
 #' @export
 #' @template example_tuner
-TunerHyperband = R6Class("TunerHyperband",
+TunerBatchHyperband = R6Class("TunerBatchHyperband",
   inherit = TunerBatchFromOptimizerBatch,
   public = list(
 
     #' @description
     #' Creates a new instance of this [R6][R6::R6Class] class.
     initialize = function() {
       super$initialize(
-        optimizer = OptimizerHyperband$new(),
+        optimizer = OptimizerBatchHyperband$new(),
         man = "mlr3hyperband::mlr_tuners_hyperband"
       )
     }
   )
 )
 
 #' @include aaa.R
-tuners[["hyperband"]] = TunerHyperband
+tuners[["hyperband"]] = TunerBatchHyperband
diff --git a/R/TunerSuccessiveHalving.R → R/TunerBatchSuccessiveHalving.R b/R/TunerSuccessiveHalving.R → R/TunerBatchSuccessiveHalving.R
@@ -1,6 +1,6 @@
 #' @title Hyperparameter Tuning with Successive Halving
 #'
-#' @include OptimizerSuccessiveHalving.R
+#' @include OptimizerBatchSuccessiveHalving.R
 #' @name mlr_tuners_successive_halving
 #' @templateVar id successive_halving
 #'
@@ -24,20 +24,20 @@
 #'
 #' @export
 #' @template example_tuner
-TunerSuccessiveHalving = R6Class("TunerSuccessiveHalving",
+TunerBatchSuccessiveHalving = R6Class("TunerBatchSuccessiveHalving",
   inherit = TunerBatchFromOptimizerBatch,
   public = list(
 
     #' @description
     #' Creates a new instance of this [R6][R6::R6Class] class.
     initialize = function() {
       super$initialize(
-        optimizer = OptimizerSuccessiveHalving$new(),
+        optimizer = OptimizerBatchSuccessiveHalving$new(),
         man = "mlr3hyperband::mlr_tuners_hyperband"
       )
     }
   )
 )
 
 #' @include aaa.R
-tuners[["successive_halving"]] = TunerSuccessiveHalving
+tuners[["successive_halving"]] = TunerBatchSuccessiveHalving
diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -11,14 +11,14 @@ Jamieson
 Lisha
 Mattermost
 ORCID
-OptimizerSuccessiveHalving
+OptimizerBatchSuccessiveHalving
 Parallelization
 Rostamizadeh
 SHA
 StackOverflow
 Stackoverflow
 Talwalkar
-TunerSuccessiveHalving
+TunerBatchSuccessiveHalving
 XGBoost
 arXiv
 bbotk

diff --git a/man/mlr_optimizers_hyperband.Rd b/man/mlr_optimizers_hyperband.Rd
diff --git a/man/mlr_optimizers_successive_halving.Rd b/man/mlr_optimizers_successive_halving.Rd
diff --git a/man/mlr_tuners_hyperband.Rd b/man/mlr_tuners_hyperband.Rd