Helpers for Parameters in Black-Box Optimization, Tuning and Machine Learning

[Up] [Top]

Documentation for package ‘ParamHelpers’ version 1.12

Help Pages

A C D E F G H I L M O P R S T U

-- A --

addOptPathEl Add a new element to an optimization path.
as.data.frame.OptPathDF Convert optimization path to data.frame.

-- C --

checkParamSet Sanity check expressions of a parameter set.
convertParamSetToIrace Converts a ParamSet object to a parameter object of the irace package.

-- D --

dfRowsToList Convert a data.frame row to list of parameter-value-lists.
dfRowToList Convert a data.frame row to list of parameter-value-lists.
discreteNameToValue Convert encoding name(s) to discrete value(s).
discreteValueToName Convert discrete value(s) to encoding name(s).
dropParams Drop Params from ParamSet by ids.

-- E --

evaluateParamExpressions Evaluates all expressions within a parameter.

-- F --

filterParams Get parameter subset of only certain parameters.
filterParamsDiscrete Get parameter subset of only certain parameters.
filterParamsNumeric Get parameter subset of only certain parameters.

-- G --

generateDesign Generates a statistical design for a parameter set.
generateDesignOfDefaults Generates a design with the defaults of a parameter set.
generateGridDesign Generates a grid design for a parameter set.
generateRandomDesign Generates a random design for a parameter set.
getDefaults Return defaults of parameters in parameter set.
getLower Get lower / upper bounds and allowed discrete values for parameters.
getOptPathBestIndex Get index of the best element from optimization path.
getOptPathCol Get column from the optimization path.
getOptPathCols Get columns from the optimization path.
getOptPathDOB Get date-of-birth vector from the optimization path.
getOptPathEl Get an element from the optimization path.
getOptPathEOL Get end-of-life vector from the optimization path.
getOptPathErrorMessages Get error-message vector from the optimization path.
getOptPathExecTimes Get exec-time vector from the optimization path.
getOptPathLength Get the length of the optimization path.
getOptPathParetoFront Get indices of pareto front of optimization path.
getOptPathX Get data.frame of input points (X-space) referring to the param set from the optimization path.
getOptPathY Get y-vector or y-matrix from the optimization path.
getParamIds Return ids of parameters in parameter set.
getParamLengths Return lengths of single parameters or parameters in parameter set.
getParamNr Return number of parameters in set.
getParamSet Get parameter set.
getParamTypeCounts Returns information on the number of parameters of a each type.
getParamTypes Returns type information for a parameter set.
getRequirements Return all require-expressions of a param set.
getTypeStrings Get parameter type-strings.
getTypeStringsAll Get parameter type-strings.
getTypeStringsCharacter Get parameter type-strings.
getTypeStringsDiscrete Get parameter type-strings.
getTypeStringsInteger Get parameter type-strings.
getTypeStringsLogical Get parameter type-strings.
getTypeStringsNumeric Get parameter type-strings.
getTypeStringsNumericStrict Get parameter type-strings.
getUpper Get lower / upper bounds and allowed discrete values for parameters.
getValues Get lower / upper bounds and allowed discrete values for parameters.

-- H --

hasCharacter Check whether parameter set contains a certain type.
hasDiscrete Check whether parameter set contains a certain type.
hasExpression Check if parameter values contain expressions.
hasFiniteBoxConstraints Checks if a parameter or each parameter of a parameter set has ONLY finite lower and upper bounds.
hasForbidden Check parameter set for forbidden region.
hasInteger Check whether parameter set contains a certain type.
hasLogical Check whether parameter set contains a certain type.
hasNumeric Check whether parameter set contains a certain type.
hasRequires Check parameter / parameter set for requirements / dependencies.
hasTrafo Check parameter / parameter set for trafos.
hasType Check whether parameter set contains a certain type.

-- I --

isCharacter Check parameter / parameter set contain ONLY a certain type.
isCharacterTypeString Check if type string is of certain type.
isDiscrete Check parameter / parameter set contain ONLY a certain type.
isDiscreteTypeString Check if type string is of certain type.
isEmpty Check whether parameter set is empty.
isFeasible Check if parameter value is valid.
isForbidden Check whether parameter setting lies in forbidden region of parameter set.
isInteger Check parameter / parameter set contain ONLY a certain type.
isIntegerTypeString Check if type string is of certain type.
isLogical Check parameter / parameter set contain ONLY a certain type.
isLogicalTypeString Check if type string is of certain type.
isNumeric Check parameter / parameter set contain ONLY a certain type.
isNumericTypeString Check if type str