From e6f755863971bd7c870cea5bcf355d5af8f5826c Mon Sep 17 00:00:00 2001 From: mb706 Date: Sun, 14 Jan 2024 18:00:42 +0100 Subject: [PATCH] document --- man-roxygen/field_param_classes.R | 3 ++- man/mlr_optimizers_mbo.Rd | 3 ++- man/mlr_tuners_mbo.Rd | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/man-roxygen/field_param_classes.R b/man-roxygen/field_param_classes.R index 0a60261c..43ed09d6 100644 --- a/man-roxygen/field_param_classes.R +++ b/man-roxygen/field_param_classes.R @@ -1,4 +1,5 @@ #' @field param_classes (`character()`)\cr #' Supported parameter classes that the optimizer can optimize. #' Determined based on the `surrogate` and the `acq_optimizer`. -#' Subclasses of [paradox::Param]. +#' This corresponds to the values given by a [paradox::ParamSet]'s +#' `$class` field. diff --git a/man/mlr_optimizers_mbo.Rd b/man/mlr_optimizers_mbo.Rd index 82e14a09..1d987644 100644 --- a/man/mlr_optimizers_mbo.Rd +++ b/man/mlr_optimizers_mbo.Rd @@ -123,7 +123,8 @@ The result assigner.} \item{\code{param_classes}}{(\code{character()})\cr Supported parameter classes that the optimizer can optimize. Determined based on the \code{surrogate} and the \code{acq_optimizer}. -Subclasses of \link[paradox:Param]{paradox::Param}.} +This corresponds to the values given by a \link[paradox:ParamSet]{paradox::ParamSet}'s +\verb{$class} field.} \item{\code{properties}}{(\code{character()})\cr Set of properties of the optimizer. diff --git a/man/mlr_tuners_mbo.Rd b/man/mlr_tuners_mbo.Rd index 36e4c887..67ea61da 100644 --- a/man/mlr_tuners_mbo.Rd +++ b/man/mlr_tuners_mbo.Rd @@ -79,7 +79,8 @@ The result assigner.} \item{\code{param_classes}}{(\code{character()})\cr Supported parameter classes that the optimizer can optimize. Determined based on the \code{surrogate} and the \code{acq_optimizer}. -Subclasses of \link[paradox:Param]{paradox::Param}.} +This corresponds to the values given by a \link[paradox:ParamSet]{paradox::ParamSet}'s +\verb{$class} field.} \item{\code{properties}}{(\code{character()})\cr Set of properties of the optimizer.