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

Functions for parameter descriptions and operations in black-box optimization, tuning and machine learning. Parameters can be described (type, constraints, defaults, etc.), combined to parameter sets and can in general be programmed on. A useful OptPath object (archive) to log function evaluations is also provided.

AuthorBernd Bischl [aut, cre], Michel Lang [aut], Jakob Bossek [aut], Daniel Horn [aut], Karin Schork [ctb], Jakob Richter [aut], Pascal Kerschke [aut]
Date of publication2017-01-05 19:24:24
MaintainerBernd Bischl <bernd_bischl@gmx.net>
LicenseBSD_2_clause + file LICENSE
Version1.10
https://github.com/berndbischl/ParamHelpers

View on CRAN

Man pages

addOptPathEl: Add a new element to an optimization path.

as.data.frame.OptPathDF: Convert optimization path to data.frame.

checkParamSet: Sanity check expressions of a parameter set.

convertParamSetToIrace: Converts a ParamSet object to a parameter object of the irace...

dfRowsToList: 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.

evaluateParamExpressions: Evaluates all expressions within a parameter.

filterParams: Get parameter subset of only certain parameters.

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...

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...

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...

getParamNr: Return number of parameters in set.

getParamSet: Get parameter set.

getParamTypeCounts: Returns information on the number of parameters of a each...

getParamTypes: Returns type information for a parameter set.

getRequirements: Return all require-expressions of a param set.

getTypeStrings: Get parameter type-strings.

hasExpression: Check if parameter values contain expressions.

hasFiniteBoxConstraints: Checks if a parameter or each parameter of a parameter set...

hasForbidden: Check parameter set for forbidden region.

hasRequires: Check parameter / parameter set for requirements /...

hasTrafo: Check parameter / parameter set for trafos.

hasType: Check whether parameter set contains a 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...

isRequiresOk: Check if parameter requirements are met.

isSpecialValue: Is a given value in the list of special values for a param?

isType: Check parameter / parameter set contain ONLY a certain type.

isTypeString: Check if type string is of certain type.

isVector: Check parameter / parameter set for vector params.

LearnerParam: Create a description object for a parameter of a machine...

makeParamSet: Construct a parameter set.

OptPath: Create optimization path.

Param: Create a description object for a parameter.

paramValueToString: Convert a value to a string.

plotEAF: Plots attainment functions for data stored in multiple...

plotOptPath: Plot method for optimization paths.

plotYTraces: Plots Y traces of multiple optimization paths

removeMissingValues: Removes all scalar NAs from a parameter setting list.

renderOptPathPlot: Function for plotting optimization paths.

renderYTraces: Plots Y traces of multiple optimization paths

repairPoint: Repairs values of numeric and integer parameters out side of...

sampleValue: Sample a random value from a parameter or a parameter set...

sampleValues: Sample n random values from a parameter or a parameter set...

setOptPathElDOB: Set the dates of birth of parameter values, in-place.

setOptPathElEOL: Set the end of life dates of parameter values, in-place.

setValueCNames: Set components names for vector names

trafoOptPath: Transform optimization path.

trafoValue: Transform a value.

updateParVals: Insert par.vals to old ones with meeting requirements

Functions

addOptPathEl Man page
as.data.frame.OptPathDF Man page
checkParamSet Man page
convertParamSetToIrace Man page
dfRowsToList Man page
dfRowToList Man page
discreteNameToValue Man page
discreteValueToName Man page
dropParams Man page
evaluateParamExpressions Man page
filterParams Man page
filterParamsDiscrete Man page
filterParamsNumeric Man page
generateDesign Man page
generateDesignOfDefaults Man page
generateGridDesign Man page
generateRandomDesign Man page
getDefaults Man page
getLower Man page
getOptPathBestIndex Man page
getOptPathCol Man page
getOptPathCols Man page
getOptPathDOB Man page
getOptPathEl Man page
getOptPathEOL Man page
getOptPathErrorMessages Man page
getOptPathExecTimes Man page
getOptPathLength Man page
getOptPathParetoFront Man page
getOptPathX Man page
getOptPathY Man page
getParamIds Man page
getParamLengths Man page
getParamNr Man page
getParamSet Man page
getParamTypeCounts Man page
getParamTypes Man page
getRequirements Man page
getTypeStrings Man page
getTypeStringsAll Man page
getTypeStringsCharacter Man page
getTypeStringsDiscrete Man page
getTypeStringsInteger Man page
getTypeStringsLogical Man page
getTypeStringsNumeric Man page
getTypeStringsNumericStrict Man page
getUpper Man page
getValues Man page
hasCharacter Man page
hasDiscrete Man page
hasExpression Man page
hasFiniteBoxConstraints Man page
hasForbidden Man page
hasInteger Man page
hasLogical Man page
hasNumeric Man page
hasRequires Man page
hasTrafo Man page
hasType Man page
isCharacter Man page
isCharacterTypeString Man page
isDiscrete Man page
isDiscreteTypeString Man page
isEmpty Man page
isFeasible Man page
isForbidden Man page
isInteger Man page
isIntegerTypeString Man page
isLogical Man page
isLogicalTypeString Man page
isNumeric Man page
isNumericTypeString Man page
isRequiresOk Man page
isSpecialValue Man page
isType Man page
isTypeString Man page
isVector Man page
isVectorTypeString Man page
LearnerParam Man page
makeCharacterParam Man page
makeCharacterVectorParam Man page
makeDiscreteLearnerParam Man page
makeDiscreteParam Man page
makeDiscreteVectorLearnerParam Man page
makeDiscreteVectorParam Man page
makeFunctionLearnerParam Man page
makeFunctionParam Man page
makeIntegerLearnerParam Man page
makeIntegerParam Man page
makeIntegerVectorLearnerParam Man page
makeIntegerVectorParam Man page
makeLogicalLearnerParam Man page
makeLogicalParam Man page
makeLogicalVectorLearnerParam Man page
makeLogicalVectorParam Man page
makeNumericLearnerParam Man page
makeNumericParam Man page
makeNumericParamSet Man page
makeNumericVectorLearnerParam Man page
makeNumericVectorParam Man page
makeOptPathDF Man page
makeParamSet Man page
makeUntypedLearnerParam Man page
makeUntypedParam Man page
OptPath Man page
OptPathDF Man page
Param Man page
ParamSet Man page
paramValueToString Man page
plotEAF Man page
plotOptPath Man page
plotYTraces Man page
removeMissingValues Man page
renderOptPathPlot Man page
renderYTraces Man page
repairPoint Man page
sampleValue Man page
sampleValues Man page
setOptPathElDOB Man page
setOptPathElEOL Man page
setValueCNames Man page
trafoOptPath Man page
trafoValue Man page
updateParVals Man page

Files

ParamHelpers
ParamHelpers/tests
ParamHelpers/tests/run-all.R
ParamHelpers/tests/testthat
ParamHelpers/tests/testthat/test_hasExpression.R
ParamHelpers/tests/testthat/Rplots.pdf
ParamHelpers/tests/testthat/test_forbidden.R
ParamHelpers/tests/testthat/test_updateParVals.R
ParamHelpers/tests/testthat/test_generateDesignOfDefaults.R
ParamHelpers/tests/testthat/test_OptPath.R
ParamHelpers/tests/testthat/test_convertDiscrete.R
ParamHelpers/tests/testthat/test_plotEAF.R
ParamHelpers/tests/testthat/test_LearnerParam.R
ParamHelpers/tests/testthat/test_sample.R
ParamHelpers/tests/testthat/test_hasIsType.R
ParamHelpers/tests/testthat/test_getRequiredParamNames.R
ParamHelpers/tests/testthat/test_isSpecialValue.R
ParamHelpers/tests/testthat/test_isFeasible.R
ParamHelpers/tests/testthat/test_Param.R
ParamHelpers/tests/testthat/test_evaluateParamExpressions.R
ParamHelpers/tests/testthat/test_renderOptPathPlot.R
ParamHelpers/tests/testthat/test_filterParams.R
ParamHelpers/tests/testthat/test_generateGridDesign.R
ParamHelpers/tests/testthat/test_generateDesign.R
ParamHelpers/tests/testthat/test_paramValueToString.R
ParamHelpers/tests/testthat/test_dropParams.R
ParamHelpers/tests/testthat/test_getParamTypes.R
ParamHelpers/tests/testthat/test_plotYTrace.R
ParamHelpers/tests/testthat/helper_zzz.R
ParamHelpers/tests/testthat/test_convertParamSetToIrace.R
ParamHelpers/tests/testthat/test_trafo.R
ParamHelpers/tests/testthat/test_generateRandomDesign.R
ParamHelpers/tests/testthat/test_getRequirements.R
ParamHelpers/tests/testthat/test_getParamTypeCounts.R
ParamHelpers/tests/testthat/test_getParamNr.R
ParamHelpers/tests/testthat/test_dfRowToList.R
ParamHelpers/tests/testthat/test_repairPoint.R
ParamHelpers/tests/testthat/test_hasFiniteBoxConstraints.R
ParamHelpers/tests/testthat/test_getDefaults.R
ParamHelpers/tests/testthat/test_hasRequires.R
ParamHelpers/tests/testthat/test_ParamSet.R
ParamHelpers/tests/testthat/test_cnames.R
ParamHelpers/tests/testthat/test_isVector.R
ParamHelpers/src
ParamHelpers/src/c_generateDesign.c
ParamHelpers/src/c_dfRowsToList.c
ParamHelpers/NAMESPACE
ParamHelpers/NEWS
ParamHelpers/R
ParamHelpers/R/OptPathDF_setter.R ParamHelpers/R/ParamSet.R ParamHelpers/R/getRequiredParamNames.R ParamHelpers/R/OptPathDF_getter.R ParamHelpers/R/convertTypesToCInts.R ParamHelpers/R/utils.R ParamHelpers/R/getParamNr.R ParamHelpers/R/dropParams.R ParamHelpers/R/OptPath_getter.R ParamHelpers/R/OptPath_plotYTraces.R ParamHelpers/R/LearnerParam.R ParamHelpers/R/isTypeString.R ParamHelpers/R/checkParamSet.R ParamHelpers/R/isRequiresOk.R ParamHelpers/R/convertDiscrete.R ParamHelpers/R/listToDfOneRow.R ParamHelpers/R/sample.R ParamHelpers/R/makeLearnerParamFuns.R ParamHelpers/R/generateDesign.R ParamHelpers/R/hasRequires.R ParamHelpers/R/getDefaults.R ParamHelpers/R/hasTrafo.R ParamHelpers/R/removeMissingValues.R ParamHelpers/R/getParamTypeCounts.R ParamHelpers/R/OptPath_plotEAF.R ParamHelpers/R/isSpecialValue.R ParamHelpers/R/getRequirements.R ParamHelpers/R/convertParamSetToIrace.R ParamHelpers/R/hasForbidden.R ParamHelpers/R/OptPath_plotter.R ParamHelpers/R/OptPathDF.R ParamHelpers/R/dfRowsToList.R ParamHelpers/R/renderOptPathPlot.R ParamHelpers/R/generateGridDesign.R ParamHelpers/R/hasExpression.R ParamHelpers/R/getBounds.R ParamHelpers/R/renderOptPathPlot_workers.R ParamHelpers/R/aParam.R ParamHelpers/R/trafo.R ParamHelpers/R/getTypeStrings.R ParamHelpers/R/isType.R ParamHelpers/R/getParamIds.R ParamHelpers/R/generateDesignOfDefaults.R ParamHelpers/R/OptPathDF_as_data_frame.R ParamHelpers/R/repairPoint.R ParamHelpers/R/filterParams.R ParamHelpers/R/generateRandomDesign.R ParamHelpers/R/hasType.R ParamHelpers/R/evaluateParamExpressions.R ParamHelpers/R/makeParamFuns.R ParamHelpers/R/updateParVals.R ParamHelpers/R/OptPath.R ParamHelpers/R/hasFiniteBoxConstraints.R ParamHelpers/R/isVector.R ParamHelpers/R/setValueCNames.R ParamHelpers/R/getParamSet.R ParamHelpers/R/getParamTypes.R ParamHelpers/R/paramValueToString.R ParamHelpers/R/OptPath_setter.R ParamHelpers/R/getParamLengths.R ParamHelpers/R/isFeasible.R ParamHelpers/R/renderOptPathPlot_helpers.R ParamHelpers/R/zzz.R ParamHelpers/R/isForbidden.R
ParamHelpers/MD5
ParamHelpers/DESCRIPTION
ParamHelpers/man
ParamHelpers/man/dropParams.Rd ParamHelpers/man/getOptPathCol.Rd ParamHelpers/man/isFeasible.Rd ParamHelpers/man/getOptPathX.Rd ParamHelpers/man/renderOptPathPlot.Rd ParamHelpers/man/getOptPathErrorMessages.Rd ParamHelpers/man/hasForbidden.Rd ParamHelpers/man/setOptPathElDOB.Rd ParamHelpers/man/paramValueToString.Rd ParamHelpers/man/renderYTraces.Rd ParamHelpers/man/sampleValue.Rd ParamHelpers/man/getRequirements.Rd ParamHelpers/man/evaluateParamExpressions.Rd ParamHelpers/man/isVector.Rd ParamHelpers/man/plotEAF.Rd ParamHelpers/man/getOptPathLength.Rd ParamHelpers/man/hasTrafo.Rd ParamHelpers/man/getOptPathY.Rd ParamHelpers/man/dfRowsToList.Rd ParamHelpers/man/getOptPathEOL.Rd ParamHelpers/man/getParamNr.Rd ParamHelpers/man/getParamSet.Rd ParamHelpers/man/getParamLengths.Rd ParamHelpers/man/getParamIds.Rd ParamHelpers/man/plotYTraces.Rd ParamHelpers/man/isForbidden.Rd ParamHelpers/man/getOptPathDOB.Rd ParamHelpers/man/removeMissingValues.Rd ParamHelpers/man/as.data.frame.OptPathDF.Rd ParamHelpers/man/Param.Rd ParamHelpers/man/trafoValue.Rd ParamHelpers/man/generateDesignOfDefaults.Rd ParamHelpers/man/LearnerParam.Rd ParamHelpers/man/setValueCNames.Rd ParamHelpers/man/filterParams.Rd ParamHelpers/man/getOptPathExecTimes.Rd ParamHelpers/man/getOptPathBestIndex.Rd ParamHelpers/man/getOptPathEl.Rd ParamHelpers/man/convertParamSetToIrace.Rd ParamHelpers/man/discreteNameToValue.Rd ParamHelpers/man/trafoOptPath.Rd ParamHelpers/man/generateRandomDesign.Rd ParamHelpers/man/isType.Rd ParamHelpers/man/getTypeStrings.Rd ParamHelpers/man/setOptPathElEOL.Rd ParamHelpers/man/getOptPathParetoFront.Rd ParamHelpers/man/discreteValueToName.Rd ParamHelpers/man/hasRequires.Rd ParamHelpers/man/getOptPathCols.Rd ParamHelpers/man/updateParVals.Rd ParamHelpers/man/isTypeString.Rd ParamHelpers/man/isEmpty.Rd ParamHelpers/man/hasType.Rd ParamHelpers/man/repairPoint.Rd ParamHelpers/man/OptPath.Rd ParamHelpers/man/addOptPathEl.Rd ParamHelpers/man/isRequiresOk.Rd ParamHelpers/man/isSpecialValue.Rd ParamHelpers/man/sampleValues.Rd ParamHelpers/man/getLower.Rd ParamHelpers/man/hasExpression.Rd ParamHelpers/man/makeParamSet.Rd ParamHelpers/man/getParamTypes.Rd ParamHelpers/man/generateDesign.Rd ParamHelpers/man/getDefaults.Rd ParamHelpers/man/getParamTypeCounts.Rd ParamHelpers/man/plotOptPath.Rd ParamHelpers/man/hasFiniteBoxConstraints.Rd ParamHelpers/man/checkParamSet.Rd ParamHelpers/man/generateGridDesign.Rd
ParamHelpers/LICENSE

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.