Learn R Programming
ParamHelpers (version 1.0-55)

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

Description

This specializes Param by adding a few more attributes, like a default value, whether it refers to a training or a predict function, etc.

Usage

makeNumericLearnerParam(id, lower = -Inf, upper = Inf,
    default, pass.default = FALSE, when = "train",
    requires = expression())
  makeNumericVectorLearnerParam(id,
    length = as.integer(NA), lower = -Inf, upper = Inf,
    default, pass.default = FALSE, when = "train",
    requires = expression())
  makeIntegerLearnerParam(id, lower = -Inf, upper = Inf,
    default, pass.default = FALSE, when = "train",
    requires = expression())
  makeIntegerVectorLearnerParam(id,
    length = as.integer(NA), lower = -Inf, upper = Inf,
    default, pass.default = FALSE, when = "train",
    requires = expression())
  makeDiscreteLearnerParam(id, values, default,
    pass.default = FALSE, when = "train",
    requires = expression())
  makeDiscreteVectorLearnerParam(id,
    length = as.integer(NA), values, default,
    pass.default = FALSE, when = "train",
    requires = expression())
  makeLogicalLearnerParam(id, default,
    pass.default = FALSE, when = "train",
    requires = expression())
  makeUntypedLearnerParam(id, default,
    pass.default = FALSE, when = "train",
    requires = expression())
  makeFunctionLearnerParam(id, default,
    pass.default = FALSE, when = "train",
    requires = expression())

Arguments

id
[character(1)] Name of parameter.
length
[integer(1)] Length of vector.
lower
[numeric] Lower bound. Default is -Inf.
upper
[numeric] Upper bound. Default is Inf.
values
[vector | list] Possible discrete values. You are allowed to pass a list of complex R values, which are used as discrete choices. If you do the latter, the elements must be uniquely named, so that the names can be used as
default
[any] Default value used in learner. If this argument is missing, it means no default value is available.
pass.default
[logical(1)] Should the default value be always passed to the learner? Default is FALSE.
when
[character(1)] Specifies when parameter is used in the learner: train, predict or both. Default is train.
requires
[expression] R expression over the other parameters to define requirements when this parameter is effective.

Value

Details

The S3 class is a list which additionally stores these elements: [object Object],[object Object],[object Object],[object Object],[object Object]