diff --git a/man-roxygen/example.R b/man-roxygen/example.R index da144ce0..571eba99 100644 --- a/man-roxygen/example.R +++ b/man-roxygen/example.R @@ -2,11 +2,32 @@ lrn = mlr3::lrn(id) pkgs = setdiff(lrn$packages, c("mlr3", "mlr3learners")) %> +#' <% task_id = if ("LearnerClassif" %in% class(lrn(id))) "sonar" else "mtcars" %> +#' #' @examples #' if (<%= paste0("requireNamespace(\"", pkgs, "\", quietly = TRUE)", collapse = " && ") %>) { -#' learner = mlr3::lrn("<%= id %>") -#' print(learner) +#' # Define the Learner and set parameter values +#' <%= sprintf("learner = lrn(\"%s\")", id)%> +#' print(learner) +#' +#' # Define a Task +#' <%= sprintf("task = tsk(\"%s\")", task_id)%> +#' +#' # Create train and test set +#' <%= sprintf("ids = partition(task)")%> +#' +#' # Train the learner on the training ids +#' <%= sprintf("learner$train(task, row_ids = ids$train)")%> +#' +#' # print the model +#' print(learner$model) +#' +#' # importance method +#' if("importance" %in% learner$properties) print(learner$importance) +#' +#' # Make predictions for the test rows +#' <%= sprintf("predictions = learner$predict(task, row_ids = ids$test)")%> #' -#' # available parameters: -#' learner$param_set$ids() +#' # Score the predictions +#' predictions$score() #' } diff --git a/man/mlr_learners_classif.cv_glmnet.Rd b/man/mlr_learners_classif.cv_glmnet.Rd index 19d9168d..b298432e 100644 --- a/man/mlr_learners_classif.cv_glmnet.Rd +++ b/man/mlr_learners_classif.cv_glmnet.Rd @@ -87,11 +87,30 @@ as the first factor level. \examples{ if (requireNamespace("glmnet", quietly = TRUE)) { - learner = mlr3::lrn("classif.cv_glmnet") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.cv_glmnet") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_classif.glmnet.Rd b/man/mlr_learners_classif.glmnet.Rd index b1397595..7cb1b4be 100644 --- a/man/mlr_learners_classif.glmnet.Rd +++ b/man/mlr_learners_classif.glmnet.Rd @@ -96,11 +96,30 @@ as the first factor level. \examples{ if (requireNamespace("glmnet", quietly = TRUE)) { - learner = mlr3::lrn("classif.glmnet") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.glmnet") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_classif.kknn.Rd b/man/mlr_learners_classif.kknn.Rd index 11e56c1f..7f386b5d 100644 --- a/man/mlr_learners_classif.kknn.Rd +++ b/man/mlr_learners_classif.kknn.Rd @@ -63,11 +63,30 @@ lrn("classif.kknn") \examples{ if (requireNamespace("kknn", quietly = TRUE)) { - learner = mlr3::lrn("classif.kknn") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.kknn") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_classif.lda.Rd b/man/mlr_learners_classif.lda.Rd index 47c51449..0e5338bb 100644 --- a/man/mlr_learners_classif.lda.Rd +++ b/man/mlr_learners_classif.lda.Rd @@ -48,11 +48,30 @@ lrn("classif.lda") \examples{ if (requireNamespace("MASS", quietly = TRUE)) { - learner = mlr3::lrn("classif.lda") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.lda") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_classif.log_reg.Rd b/man/mlr_learners_classif.log_reg.Rd index cc24971a..16029543 100644 --- a/man/mlr_learners_classif.log_reg.Rd +++ b/man/mlr_learners_classif.log_reg.Rd @@ -84,11 +84,30 @@ Instead, set the respective hyperparameter or use \CRANpkg{mlr3pipelines} to cre \examples{ if (requireNamespace("stats", quietly = TRUE)) { - learner = mlr3::lrn("classif.log_reg") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.log_reg") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \seealso{ diff --git a/man/mlr_learners_classif.multinom.Rd b/man/mlr_learners_classif.multinom.Rd index 5c975802..8b042495 100644 --- a/man/mlr_learners_classif.multinom.Rd +++ b/man/mlr_learners_classif.multinom.Rd @@ -53,11 +53,30 @@ lrn("classif.multinom") \examples{ if (requireNamespace("nnet", quietly = TRUE)) { - learner = mlr3::lrn("classif.multinom") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.multinom") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \seealso{ diff --git a/man/mlr_learners_classif.naive_bayes.Rd b/man/mlr_learners_classif.naive_bayes.Rd index b4115d46..1aea0b73 100644 --- a/man/mlr_learners_classif.naive_bayes.Rd +++ b/man/mlr_learners_classif.naive_bayes.Rd @@ -38,11 +38,30 @@ lrn("classif.naive_bayes") \examples{ if (requireNamespace("e1071", quietly = TRUE)) { - learner = mlr3::lrn("classif.naive_bayes") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.naive_bayes") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \seealso{ diff --git a/man/mlr_learners_classif.nnet.Rd b/man/mlr_learners_classif.nnet.Rd index 4e5cb3c4..d8fdca4b 100644 --- a/man/mlr_learners_classif.nnet.Rd +++ b/man/mlr_learners_classif.nnet.Rd @@ -73,11 +73,30 @@ lrn("classif.nnet") \examples{ if (requireNamespace("nnet", quietly = TRUE)) { - learner = mlr3::lrn("classif.nnet") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.nnet") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_classif.qda.Rd b/man/mlr_learners_classif.qda.Rd index f0f77b20..677632a8 100644 --- a/man/mlr_learners_classif.qda.Rd +++ b/man/mlr_learners_classif.qda.Rd @@ -46,11 +46,30 @@ lrn("classif.qda") \examples{ if (requireNamespace("MASS", quietly = TRUE)) { - learner = mlr3::lrn("classif.qda") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.qda") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_classif.ranger.Rd b/man/mlr_learners_classif.ranger.Rd index ff6140b1..bc99c505 100644 --- a/man/mlr_learners_classif.ranger.Rd +++ b/man/mlr_learners_classif.ranger.Rd @@ -89,11 +89,30 @@ lrn("classif.ranger") \examples{ if (requireNamespace("ranger", quietly = TRUE)) { - learner = mlr3::lrn("classif.ranger") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.ranger") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_classif.svm.Rd b/man/mlr_learners_classif.svm.Rd index 9364af06..cd817879 100644 --- a/man/mlr_learners_classif.svm.Rd +++ b/man/mlr_learners_classif.svm.Rd @@ -51,11 +51,30 @@ lrn("classif.svm") \examples{ if (requireNamespace("e1071", quietly = TRUE)) { - learner = mlr3::lrn("classif.svm") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.svm") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_classif.xgboost.Rd b/man/mlr_learners_classif.xgboost.Rd index e0f86a3b..98fa6ca3 100644 --- a/man/mlr_learners_classif.xgboost.Rd +++ b/man/mlr_learners_classif.xgboost.Rd @@ -148,11 +148,30 @@ lrn("classif.xgboost") \examples{ if (requireNamespace("xgboost", quietly = TRUE)) { - learner = mlr3::lrn("classif.xgboost") - print(learner) +# Define the Learner and set parameter values +learner = lrn("classif.xgboost") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("sonar") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } # Train learner with early stopping on spam data set diff --git a/man/mlr_learners_regr.cv_glmnet.Rd b/man/mlr_learners_regr.cv_glmnet.Rd index 42a81519..1ab38588 100644 --- a/man/mlr_learners_regr.cv_glmnet.Rd +++ b/man/mlr_learners_regr.cv_glmnet.Rd @@ -80,11 +80,30 @@ lrn("regr.cv_glmnet") \examples{ if (requireNamespace("glmnet", quietly = TRUE)) { - learner = mlr3::lrn("regr.cv_glmnet") - print(learner) +# Define the Learner and set parameter values +learner = lrn("regr.cv_glmnet") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("mtcars") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_regr.glmnet.Rd b/man/mlr_learners_regr.glmnet.Rd index e100f539..2938319e 100644 --- a/man/mlr_learners_regr.glmnet.Rd +++ b/man/mlr_learners_regr.glmnet.Rd @@ -96,11 +96,30 @@ lrn("regr.glmnet") \examples{ if (requireNamespace("glmnet", quietly = TRUE)) { - learner = mlr3::lrn("regr.glmnet") - print(learner) +# Define the Learner and set parameter values +learner = lrn("regr.glmnet") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("mtcars") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_regr.kknn.Rd b/man/mlr_learners_regr.kknn.Rd index c00a8f22..48346ecb 100644 --- a/man/mlr_learners_regr.kknn.Rd +++ b/man/mlr_learners_regr.kknn.Rd @@ -63,11 +63,30 @@ lrn("regr.kknn") \examples{ if (requireNamespace("kknn", quietly = TRUE)) { - learner = mlr3::lrn("regr.kknn") - print(learner) +# Define the Learner and set parameter values +learner = lrn("regr.kknn") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("mtcars") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_regr.km.Rd b/man/mlr_learners_regr.km.Rd index 4e254363..79ac415f 100644 --- a/man/mlr_learners_regr.km.Rd +++ b/man/mlr_learners_regr.km.Rd @@ -72,11 +72,30 @@ lrn("regr.km") \examples{ if (requireNamespace("DiceKriging", quietly = TRUE)) { - learner = mlr3::lrn("regr.km") - print(learner) +# Define the Learner and set parameter values +learner = lrn("regr.km") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("mtcars") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_regr.lm.Rd b/man/mlr_learners_regr.lm.Rd index 34013e0e..f9ac44ab 100644 --- a/man/mlr_learners_regr.lm.Rd +++ b/man/mlr_learners_regr.lm.Rd @@ -61,11 +61,30 @@ Instead, set the respective hyperparameter or use \CRANpkg{mlr3pipelines} to cre \examples{ if (requireNamespace("stats", quietly = TRUE)) { - learner = mlr3::lrn("regr.lm") - print(learner) +# Define the Learner and set parameter values +learner = lrn("regr.lm") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("mtcars") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \seealso{ diff --git a/man/mlr_learners_regr.nnet.Rd b/man/mlr_learners_regr.nnet.Rd index 2be71f06..7fa81f08 100644 --- a/man/mlr_learners_regr.nnet.Rd +++ b/man/mlr_learners_regr.nnet.Rd @@ -73,11 +73,30 @@ lrn("regr.nnet") \examples{ if (requireNamespace("nnet", quietly = TRUE)) { - learner = mlr3::lrn("regr.nnet") - print(learner) +# Define the Learner and set parameter values +learner = lrn("regr.nnet") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("mtcars") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_regr.ranger.Rd b/man/mlr_learners_regr.ranger.Rd index 79d16a53..9876d580 100644 --- a/man/mlr_learners_regr.ranger.Rd +++ b/man/mlr_learners_regr.ranger.Rd @@ -89,11 +89,30 @@ Note that \code{mtry} and \code{mtry.ratio} are mutually exclusive. \examples{ if (requireNamespace("ranger", quietly = TRUE)) { - learner = mlr3::lrn("regr.ranger") - print(learner) +# Define the Learner and set parameter values +learner = lrn("regr.ranger") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("mtcars") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_regr.svm.Rd b/man/mlr_learners_regr.svm.Rd index 5c6823d9..73f29da4 100644 --- a/man/mlr_learners_regr.svm.Rd +++ b/man/mlr_learners_regr.svm.Rd @@ -49,11 +49,30 @@ lrn("regr.svm") \examples{ if (requireNamespace("e1071", quietly = TRUE)) { - learner = mlr3::lrn("regr.svm") - print(learner) +# Define the Learner and set parameter values +learner = lrn("regr.svm") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("mtcars") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } } \references{ diff --git a/man/mlr_learners_regr.xgboost.Rd b/man/mlr_learners_regr.xgboost.Rd index 74d4a93a..9efdc31f 100644 --- a/man/mlr_learners_regr.xgboost.Rd +++ b/man/mlr_learners_regr.xgboost.Rd @@ -147,11 +147,30 @@ would error. Just setting a nonsense default to workaround this. \examples{ if (requireNamespace("xgboost", quietly = TRUE)) { - learner = mlr3::lrn("regr.xgboost") - print(learner) +# Define the Learner and set parameter values +learner = lrn("regr.xgboost") +print(learner) - # available parameters: -learner$param_set$ids() +# Define a Task +task = tsk("mtcars") + +# Create train and test set +ids = partition(task) + +# Train the learner on the training ids +learner$train(task, row_ids = ids$train) + +# print the model +print(learner$model) + +# importance method +if("importance" \%in\% learner$properties) print(learner$importance) + +# Make predictions for the test rows +predictions = learner$predict(task, row_ids = ids$test) + +# Score the predictions +predictions$score() } # Train learner with early stopping on spam data set