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

ParamHelpers (version 1.8)

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

7,492

Version

1.8

License

BSD_3_clause + file LICENSE

Issues

54

Pull Requests

9

Stars

26

Forks

10

Maintainer

Bernd Bischl

Last Published

July 19th, 2016

Functions in ParamHelpers (1.8)

filterParams

Get parameter subset of only certain parameters.
as.data.frame.OptPathDF

Convert optimization path to data.frame.
addOptPathEl

Add a new element to an optimization path.
dropParams

Drop Params from ParamSet by ids.
discreteValueToName

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

Generates a statistical design for a parameter set.
convertParamSetToIrace

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

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

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

Generates a grid design for a parameter set.
getOptPathDOB

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

Get lower / upper bounds and allowed discrete values for parameters.
getOptPathEl

Get an element from the optimization path.
getOptPathCols

Get columns from the optimization path.
getOptPathBestIndex

Get index of the best element from optimization path.
getOptPathCol

Get column from the optimization path.
getDefaults

Return defaults of parameters in parameter set.
generateRandomDesign

Generates a random design for a parameter set.
getOptPathEOL

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

Get error-message vector from the optimization path.
getParamNr

Return number of parameters in set.
getParamLengths

Return lengths of parameters in parameter set.
getOptPathY

Get y-vector or y-matrix from the optimization path.
getOptPathX

Get data.frame of input points (X-space) referring to the param set from the optimization path.
getParamIds

Return ids of parameters in parameter set.
getOptPathParetoFront

Get indices of pareto front of optimization path.
getOptPathExecTimes

Get exec-time vector from the optimization path.
getOptPathLength

Get the length of the optimization path.
getParamTypeCounts

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

Get parameter set.
isFeasible

Check if parameter value is valid.
isEmpty

Check whether parameter set is empty.
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.
hasTrafo

Check parameter / parameter set for trafos.
hasRequires

Check parameter / parameter set for requirements / dependencies.
isForbidden

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

Returns type information for a parameter set.
getTypeStrings

Get parameter type-strings.
hasType

Check whether parameter set contains a certain type.
isType

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

Check parameter / parameter set for vector params.
Param

Create a description object for a parameter.
plotEAF

Plots attainment functions for data stored in multiple OptPaths.
paramValueToString

Convert a value to a string.
OptPath

Create optimization path.
LearnerParam

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

Construct a parameter set.
setValueCNames

Set components names for vector names
trafoOptPath

Transform optimization path.
removeMissingValues

Removes all scalar NAs from a parameter setting list.
setOptPathElDOB

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

Function for plotting optimization paths.
trafoValue

Transform a value.
setOptPathElEOL

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

Insert par.vals to old ones with meeting requirements
repairPoint

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

Plots Y traces of multiple optimization paths
plotOptPath

Plot method for optimization paths.
plotYTraces

Plots Y traces of multiple optimization paths
sampleValue

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

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