From 4816287dc1197fd6b900e48db17ad5542a418b06 Mon Sep 17 00:00:00 2001 From: Jakob Richter Date: Tue, 2 Jan 2018 13:22:58 +0100 Subject: [PATCH] roxygen [ci skip] --- man/error_handling.Rd | 2 +- man/getSupportedMultipointInfillOptFunctions.Rd | 4 ++-- man/mbo_OptPath.Rd | 2 +- man/mbo_parallel.Rd | 2 +- man/plotExampleRun.Rd | 2 +- man/renderExampleRunPlot.Rd | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/man/error_handling.Rd b/man/error_handling.Rd index fc776e650..6e726c379 100644 --- a/man/error_handling.Rd +++ b/man/error_handling.Rd @@ -15,7 +15,7 @@ The target function could \item{4}{The target function crashes the whole R process.} \item{5}{The surrogate machine learning model might crash. Kriging quite often can run into numerical problems.} - \item{6}{The proposal mechanism - in multipoint or single point mode - produces + \item{6}{The proposal mechanism - in multi-point or single point mode - produces a point which is either close to another candidate point in the same iteration or an already visited point in a previous iteration.} \item{7}{The mbo process exits / stops / crashes itself. Maybe because it hit a walltime.} diff --git a/man/getSupportedMultipointInfillOptFunctions.Rd b/man/getSupportedMultipointInfillOptFunctions.Rd index 00a8bb800..e497e422e 100644 --- a/man/getSupportedMultipointInfillOptFunctions.Rd +++ b/man/getSupportedMultipointInfillOptFunctions.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/getSupportedMultipointInfillOptFunctions.R \name{getSupportedMultipointInfillOptFunctions} \alias{getSupportedMultipointInfillOptFunctions} -\title{Get names of supported multipoint infill-criteria optimizers.} +\title{Get names of supported multi-point infill-criteria optimizers.} \usage{ getSupportedMultipointInfillOptFunctions() } @@ -10,5 +10,5 @@ getSupportedMultipointInfillOptFunctions() [\code{character}] } \description{ -Returns all names of supported multipoint infill-criteria optimizers. +Returns all names of supported multi-point infill-criteria optimizers. } diff --git a/man/mbo_OptPath.Rd b/man/mbo_OptPath.Rd index d83c5ed42..7fd10f869 100644 --- a/man/mbo_OptPath.Rd +++ b/man/mbo_OptPath.Rd @@ -20,7 +20,7 @@ The extras are: \item{final\_eval}{If \code{final.evals} is set in \code{\link{makeMBOControl}}: Final evaluations of the proposed solution to reduce noise in y.} } } -\item{parego.weight}{Weight vector sampled for multipoint ParEGO} +\item{parego.weight}{Weight vector sampled for multi-point ParEGO} \item{...}{Depending on the chosen infill criterion there will be additional columns, e.g. \code{se} and \code{mean} for the Expected Improvement)} } diff --git a/man/mbo_parallel.Rd b/man/mbo_parallel.Rd index 037e46876..ca383e3ab 100644 --- a/man/mbo_parallel.Rd +++ b/man/mbo_parallel.Rd @@ -19,7 +19,7 @@ Details for the levels mentioned above are given below: } Details regarding the latter: \describe{ -\item{single-objective MBO with LCB multipoint}{Parallel optimization of LCBs for the lambda-values.} +\item{single-objective MBO with LCB multi-point}{Parallel optimization of LCBs for the lambda-values.} \item{Multi-objective MBO with ParEGO}{Parallel optimization of scalarization functions.} } } diff --git a/man/plotExampleRun.Rd b/man/plotExampleRun.Rd index 62d99084a..13024b00d 100644 --- a/man/plotExampleRun.Rd +++ b/man/plotExampleRun.Rd @@ -33,7 +33,7 @@ is plotted above and below. Default is 1.} \item{single.prop.point.plots}{[\code{logical(1)}]\cr -Parameter for MOI-MBO Multipoint proposal: Should every proposed point +Parameter for MOI-MBO Multi-point proposal: Should every proposed point be displayed in a single plot - or one plot per Iteration? Default is FALSE indicating single plots per proposed points.} diff --git a/man/renderExampleRunPlot.Rd b/man/renderExampleRunPlot.Rd index 49905745d..de888f594 100644 --- a/man/renderExampleRunPlot.Rd +++ b/man/renderExampleRunPlot.Rd @@ -28,7 +28,7 @@ is plotted above and below. Default is 1.} \item{single.prop.point.plots}{[\code{logical(1)}]\cr -Parameter for MOI-MBO Multipoint proposal: Should every proposed point +Parameter for MOI-MBO Multi-point proposal: Should every proposed point be displayed in a single plot - or one plot per Iteration? Default is FALSE indicating single plots per proposed points.}