helpLearnerParam: Get specific help for a learner's parameters.

View source: R/helpLearner.R

helpLearnerParamR Documentation

Get specific help for a learner's parameters.

Description

Print the description of parameters of a given learner. The description is automatically extracted from the help pages of the learner, so it may be incomplete.

Usage

helpLearnerParam(learner, param = NULL)

Arguments

learner

(Learner | character(1))
The learner. If you pass a string the learner will be created via makeLearner.

param

(character | NULL)
Parameter(s) to describe. Defaults to NULL, which prints information on the documentation status of all parameters.

See Also

Other learner: LearnerProperties, getClassWeightParam(), getHyperPars(), getLearnerId(), getLearnerNote(), getLearnerPackages(), getLearnerParVals(), getLearnerParamSet(), getLearnerPredictType(), getLearnerShortName(), getLearnerType(), getParamSet(), helpLearner(), makeLearners(), makeLearner(), removeHyperPars(), setHyperPars(), setId(), setLearnerId(), setPredictThreshold(), setPredictType()

Other help: helpLearner()


berndbischl/mlr documentation built on Aug. 15, 2024, 4:20 p.m.