getHyperPars: Get current parameter settings for a learner.

In mlr-org/mlr: Machine Learning in R

Get current parameter settings for a learner.

Description

Retrieves the current hyperparameter settings of a learner.

Usage

getHyperPars(learner, for.fun = c("train", "predict", "both"))

Arguments

learner	(Learner) The learner.
for.fun	(character(1)) Restrict the returned settings to hyperparameters corresponding to when the are used (see ParamHelpers::LearnerParam). Must be a subset of: “train”, “predict” or “both”. Default is c("train", "predict", "both").

Details

This function only shows hyperparameters that differ from the learner default (because mlr changed the default) or if the user set hyperparameters manually during learner creation. If you want to have an overview of all available hyperparameters use getParamSet().

Value

(list). A named list of values.

See Also

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

Examples

getHyperPars(makeLearner("classif.ranger"))

## set learner hyperparameter `mtry` manually
getHyperPars(makeLearner("classif.ranger", mtry = 100))

mlr-org/mlr documentation built on Jan. 12, 2023, 5:16 a.m.