Learn R Programming

⚠️There's a newer version (1.14.2) of this package.Take me there.

ParamHelpers (version 1.10)

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

Description

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.

Copy Link

Version

Install

install.packages('ParamHelpers')

Monthly Downloads

8,278

Version

1.10

License

BSD_2_clause + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Bernd Bischl

Last Published

January 5th, 2017

Functions in ParamHelpers (1.10)

discreteValueToName

Convert discrete value(s) to encoding name(s).
checkParamSet

Sanity check expressions of a parameter set.
as.data.frame.OptPathDF

Convert optimization path to data.frame.
evaluateParamExpressions

Evaluates all expressions within a parameter.
dropParams

Drop Params from ParamSet by ids.
filterParams

Get parameter subset of only certain parameters.
discreteNameToValue

Convert encoding name(s) to discrete value(s).
convertParamSetToIrace

Converts a ParamSet object to a parameter object of the irace package.
addOptPathEl

Add a new element to an optimization path.
dfRowsToList

Convert a data.frame row to list of parameter-value-lists.
getOptPathBestIndex

Get index of the best element from optimization path.
generateDesign

Generates a statistical design for a parameter set.
getOptPathCol

Get column from the optimization path.
generateRandomDesign

Generates a random design for a parameter set.
generateGridDesign

Generates a grid design for a parameter set.
generateDesignOfDefaults

Generates a design with the defaults of a parameter set.
getOptPathCols

Get columns from the optimization path.
getDefaults

Return defaults of parameters in parameter set.
getOptPathDOB

Get date-of-birth vector from the optimization path.
getLower

Get lower / upper bounds and allowed discrete values for parameters.
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.
getParamTypes

Returns type information for a parameter set.
isTypeString

Check if type string is of certain type.
isVector

Check parameter / parameter set for vector params.
getParamTypeCounts

Returns information on the number of parameters of a each type.
getOptPathLength

Get the length of the optimization path.
getOptPathParetoFront

Get indices of pareto front of optimization path.
paramValueToString

Convert a value to a string.
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.
isType

Check parameter / parameter set contain ONLY a certain type.
isSpecialValue

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

Plot method for optimization paths.
Param

Create a description object for a parameter.
makeParamSet

Construct a parameter set.
getParamLengths

Return lengths of single parameters or parameters in parameter set.
getParamIds

Return ids of parameters in parameter set.
getOptPathErrorMessages

Get error-message vector from the optimization path.
getOptPathExecTimes

Get exec-time vector from the optimization path.
getParamNr

Return number of parameters in set.
sampleValue

Sample a random value from a parameter or a parameter set uniformly.
isFeasible

Check if parameter value is valid.
getParamSet

Get parameter set.
isEmpty

Check whether parameter set is empty.
plotYTraces

Plots Y traces of multiple optimization paths
setValueCNames

Set components names for vector names
getOptPathEl

Get an element from the optimization path.
trafoOptPath

Transform optimization path.
getOptPathEOL

Get end-of-life vector from the optimization path.
getTypeStrings

Get parameter type-strings.
getRequirements

Return all require-expressions of a param set.
isForbidden

Check whether parameter setting lies in forbidden region of parameter set.
isRequiresOk

Check if parameter requirements are met.
renderYTraces

Plots Y traces of multiple optimization paths
updateParVals

Insert par.vals to old ones with meeting requirements
trafoValue

Transform a value.
repairPoint

Repairs values of numeric and integer parameters out side of constraints.
hasRequires

Check parameter / parameter set for requirements / dependencies.
hasForbidden

Check parameter set for forbidden region.
hasType

Check whether parameter set contains a certain type.
removeMissingValues

Removes all scalar NAs from a parameter setting list.
hasTrafo

Check parameter / parameter set for trafos.
renderOptPathPlot

Function for plotting optimization paths.
setOptPathElEOL

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

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

Plots attainment functions for data stored in multiple OptPaths.
sampleValues

Sample n random values from a parameter or a parameter set uniformly.
LearnerParam

Create a description object for a parameter of a machine learning algorithm.
OptPath

Create optimization path.