Learn R Programming

ParamHelpers (version 1.14.2)

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

6,604

Version

1.14.2

License

BSD_2_clause + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/mlr-org/ParamHelpers

Homepage

https://paramhelpers.mlr-org.com

Maintainer

Martin Binder

Last Published

January 9th, 2025

Functions in ParamHelpers (1.14.2)

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

generateDesignOfDefaults

Generates a design with the defaults of a parameter set.

Return defaults of parameters in parameter set.

generateRandomDesign

Generates a random design for a parameter set.

Get parameter subset of only certain parameters.

getOptPathBestIndex

Get index of the best element from optimization path.

generateGridDesign

Generates a grid design for a parameter set.

Drop Params from ParamSet by ids.

Generates a statistical design for a parameter set.

evaluateParamExpressions

Evaluates all expressions within a parameter.

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

getOptPathExecTimes

Get exec-time vector from the optimization path.

Get column from the optimization path.

getOptPathParetoFront

Get indices of pareto front of optimization path.

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

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

getOptPathLength

Get the length of the optimization path.

Get parameter set.

Check parameter set for forbidden region.

hasFiniteBoxConstraints

Checks if a parameter or each parameter of a parameter set has ONLY finite lower and upper bounds.

getParamTypeCounts

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

Return number of parameters in set.

Check whether parameter set is empty.

getOptPathErrorMessages

Get error-message vector from the optimization path.

Check whether parameter set contains a certain type.

getParamLengths

Return lengths of single parameters or parameters in parameter set.

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

Get an element from the optimization path.

Construct a parameter set.

Plots attainment functions for data stored in multiple OptPaths.

paramValueToString

Convert a value to a string.

Plot method for optimization paths.

Return ids of parameters in parameter set.

Check if parameter value is valid.

Get columns from the optimization path.

Returns type information for a parameter set.

getRequirements

Return all require-expressions of a param set.

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

Check parameter / parameter set for requirements / dependencies.

setOptPathElEOL

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

Set components names for vector names

Transform a value.

Transform optimization path.

Get parameter type-strings.

Convert a list to a data.frame with one row

Check if parameter requirements are met.

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

Check if parameter values contain expressions.

Check parameter / parameter set for vector params.

renderOptPathPlot

Function for plotting optimization paths.

Plots Y traces of multiple optimization paths

Plots Y traces of multiple optimization paths

Insert par.vals to old ones with meeting requirements

Check parameter / parameter set for trafos.

Check parameter / parameter set contain ONLY a certain type.

removeMissingValues

Removes all scalar NAs from a parameter setting list.

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

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

Check if type string is of certain type.

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

setOptPathElDOB

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

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

Create optimization path.

discreteValueToName

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

Add a new element to an optimization path.

as.data.frame.OptPathDF

Convert optimization path to data.frame.

discreteNameToValue

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

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

Sanity check expressions of a parameter set.

Create a description object for a parameter.

convertParamSetToIrace

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