Learn R Programming

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

ParamHelpers (version 1.14)

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

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

Jakob Richter

Last Published

March 24th, 2020

Functions in ParamHelpers (1.14)

convertParamSetToIrace

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

generateRandomDesign

Generates a random design for a parameter set.

Get an element from the optimization path.

getOptPathErrorMessages

Get error-message vector from the optimization path.

Return defaults of parameters in parameter set.

Create a description object for a parameter.

Add a new element to an optimization path.

Return number of parameters in set.

Check whether parameter set contains a certain type.

getParamLengths

Return lengths of single parameters or parameters in parameter set.

Convert a list to a data.frame with one row

Check whether parameter set is empty.

Check parameter / parameter set for vector params.

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

discreteNameToValue

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

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

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

getOptPathBestIndex

Get index of the best element from optimization path.

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

discreteValueToName

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

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

evaluateParamExpressions

Evaluates all expressions within a parameter.

Get columns from the optimization path.

Get column from the optimization path.

Drop Params from ParamSet by ids.

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

Create optimization path.

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

getOptPathExecTimes

Get exec-time vector from the optimization path.

generateDesignOfDefaults

Generates a design with the defaults of a parameter set.

generateGridDesign

Generates a grid design for a parameter set.

getOptPathLength

Get the length of 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.

Return ids of parameters in parameter set.

Check if parameter value is valid.

Construct a parameter set.

Sanity check expressions of a parameter set.

Generates a statistical design for a parameter set.

Get parameter subset of only certain parameters.

as.data.frame.OptPathDF

Convert optimization path to data.frame.

Check parameter / parameter set for requirements / dependencies.

Check parameter / parameter set for trafos.

paramValueToString

Convert a value to a string.

Transform optimization path.

Transform a value.

getOptPathParetoFront

Get indices of pareto front of optimization path.

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

Get parameter set.

Check parameter / parameter set contain ONLY a certain type.

getParamTypeCounts

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

Check if parameter requirements are met.

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.

Get parameter type-strings.

Check parameter set for forbidden region.

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

Plots Y traces of multiple optimization paths

removeMissingValues

Removes all scalar NAs from a parameter setting list.

setOptPathElDOB

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

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

Insert par.vals to old ones with meeting requirements

Check if type string is of certain type.

Plots Y traces of multiple optimization paths

renderOptPathPlot

Function for plotting optimization paths.

Plots attainment functions for data stored in multiple OptPaths.

Plot method for optimization paths.

setOptPathElEOL

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

Set components names for vector names

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