Learn R Programming

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

ParamHelpers (version 1.14.1)

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

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

July 4th, 2022

Functions in ParamHelpers (1.14.1)

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

Sanity check expressions of a parameter set.

discreteValueToName

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

discreteNameToValue

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

as.data.frame.OptPathDF

Convert optimization path to data.frame.

Add a new element to an optimization path.

convertParamSetToIrace

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

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

Create optimization path.

Create a description object for a parameter.

Drop Params from ParamSet by ids.

generateGridDesign

Generates a grid design for a parameter set.

getOptPathBestIndex

Get index of the best element from optimization path.

Generates a statistical design for a parameter set.

Return defaults of parameters in parameter set.

Get parameter subset of only certain parameters.

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

generateRandomDesign

Generates a random design for a parameter set.

generateDesignOfDefaults

Generates a design with the defaults of a parameter set.

getOptPathExecTimes

Get exec-time vector from the optimization path.

Get an element from the optimization path.

getOptPathErrorMessages

Get error-message vector from the optimization path.

Get column from the optimization path.

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

evaluateParamExpressions

Evaluates all expressions within a parameter.

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

getParamLengths

Return lengths of single parameters or parameters in parameter set.

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.

Return number of parameters in set.

Get parameter type-strings.

Check if parameter values contain expressions.

getOptPathLength

Get the length of the optimization path.

Check if parameter value is valid.

getRequirements

Return all require-expressions of a param set.

Returns type information for a parameter set.

Check parameter / parameter set for requirements / dependencies.

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

Get parameter set.

Get columns from the optimization path.

Check if parameter requirements are met.

paramValueToString

Convert a value to a string.

Construct a parameter set.

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

Check parameter / parameter set for trafos.

Transform optimization path.

Convert a list to a data.frame with one row

Check parameter / parameter set for vector params.

setOptPathElEOL

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

Check parameter / parameter set contain ONLY a certain type.

Check if type string is of certain type.

Transform a value.

hasFiniteBoxConstraints

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

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

Plots attainment functions for data stored in multiple OptPaths.

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

Return ids of parameters in parameter set.

Check parameter set for forbidden region.

getParamTypeCounts

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

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

Plot method for optimization paths.

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

Set components names for vector names

Plots Y traces of multiple optimization paths

Check whether parameter set contains a certain type.

Plots Y traces of multiple optimization paths

Check whether parameter set is empty.

removeMissingValues

Removes all scalar NAs from a parameter setting list.

renderOptPathPlot

Function for plotting optimization paths.

Insert par.vals to old ones with meeting requirements

setOptPathElDOB

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