Add progressbar section

NEWS.md

@@ -7,8 +7,9 @@
 * `ArchiveBest` stores no data but records the best scoring evaluation.
 * Reduced runtime if `ObjectiveRFunDt` and a domain without trafo is used.
 * `OptimizerDesignPoints` supports `ParamUty`.
-* Start values for `OptimizerCmaes` abd `OptimizerNloptr` are created randomly or
-  from center of search space.
+* Start values for `OptimizerCmaes` abd `OptimizerNloptr` are created randomly
+  or from center of search space.
+* `Optimizer$optimize()` supports progress bars via the package `progressr`.
 
 # bbotk 0.2.2
 

R/Optimizer.R

@@ -11,11 +11,7 @@
 #' of the [OptimInstance] at the end in order to store the best point  and its
 #' estimated performance vector.
 #'
-#' @section Progress Bars:
-#' `$optimize()` supports progress bars via the package \CRANpkg{progressr}
-#' combined with a [Terminator]. Simply wrap the function in
-#' `progressr::with_progress()` to enable them. We recommend to use package
-#' \CRANpkg{progress} as backend; enable with `progressr::handlers("progress")`.
+#' @template section_progress_bars
 #' @export
 Optimizer = R6Class("Optimizer",
   public = list(

R/OptimizerCmaes.R

@@ -21,6 +21,8 @@
 #' For the meaning of the control parameters, see [adagio::pureCMAES()]. Note
 #' that we have removed all control parameters which refer to the termination of
 #' the algorithm and where our terminators allow to obtain the same behavior.
+#' 
+#' @template section_progress_bars
 #'
 #' @export
 #' @examples

R/OptimizerDesignPoints.R

@@ -23,6 +23,8 @@
 #' \item{`design`}{[data.table::data.table]\cr
 #' Design points to try in search, one per row.}
 #' }
+#' 
+#' @template section_progress_bars
 #'
 #' @export
 #' @examples

R/OptimizerGenSA.R

@@ -22,6 +22,8 @@
 #' For the meaning of the control parameters, see [GenSA::GenSA()]. Note that we
 #' have removed all control parameters which refer to the termination of the
 #' algorithm and where our terminators allow to obtain the same behavior.
+#' 
+#' @template section_progress_bars
 #'
 #' @source
 #' `r format_bib("tsallis_1996", "xiang_2013")`

R/OptimizerGridSearch.R

@@ -27,6 +27,8 @@
 #' \item{`batch_size`}{`integer(1)`\cr
 #' Maximum number of points to try in a batch.}
 #' }
+#' 
+#' @template section_progress_bars
 #'
 #' @export
 #' @template example

R/OptimizerNLoptr.R

@@ -29,6 +29,8 @@
 #' (`xtol_rel = 10^-4`, `xtol_abs = rep(0.0, length(x0))`, `ftol_rel = 0.0` and
 #' `ftol_abs = 0.0`) are still available and implemented with their package
 #' defaults. To deactivate these conditions, set them to `-1`.
+#' 
+#' @template section_progress_bars
 #'
 #' @source
 #' `r format_bib("johnson_2014")`

R/OptimizerRandomSearch.R

@@ -20,6 +20,8 @@
 #' Maximum number of points to try in a batch.}
 #' }
 #'
+#' @template section_progress_bars
+#' 
 #' @source
 #' `r format_bib("bergstra_2012")`
 #'

man-roxygen/param_search_space.R

@@ -1,4 +1,6 @@
 #' @param search_space ([paradox::ParamSet])\cr
-#'   Specifies the search space for the [Optimizer].
-#'   The [paradox::ParamSet] describes either a subset of the `domain` of the [Objective] or it describes a set of parameters together with a `trafo` function that transforms values from the search space to values of the domain.
-#'   Depending on the context, this value defaults to the domain of the objective.
+#' Specifies the search space for the [Optimizer]. The [paradox::ParamSet]
+#' describes either a subset of the `domain` of the [Objective] or it describes
+#' a set of parameters together with a `trafo` function that transforms values
+#' from the search space to values of the domain. Depending on the context, this
+#' value defaults to the domain of the objective.

man-roxygen/section_progress_bars.R

@@ -0,0 +1,5 @@
+#' @section Progress Bars:
+#' `$optimize()` supports progress bars via the package \CRANpkg{progressr}
+#' combined with a [Terminator]. Simply wrap the function in
+#' `progressr::with_progress()` to enable them. We recommend to use package
+#' \CRANpkg{progress} as backend; enable with `progressr::handlers("progress")`.