Merge pull request #264 from mlr-org/nnet

feat: allow formula as argument for nnet learner

Author: sebffischer

NEWS.md

@@ -1,4 +1,8 @@
-# mlr3learners 0.5.5
+# mlr3learners 0.5.6-9000
+
+* Added formula argument to `nnet` learner and support feature type `"integer"`
+
+# mlr3learners 0.5.6
 
 - Enable new early stopping mechanism for xgboost.
 - Improved documentation.

R/LearnerClassifNnet.R

@@ -17,6 +17,9 @@
 #'   - Adjusted default: 3L.
 #'   - Reason for change: no default in `nnet()`.
 #'
+#' @section Custom mlr3 parameters:
+#' - `formula`: if not provided, the formula is set to `task$formula()`.
+#'
 #' @references
 #' `r format_bib("ripley_1996")`
 #'
@@ -46,14 +49,15 @@ LearnerClassifNnet = R6Class("LearnerClassifNnet",
         size      = p_int(0L, default = 3L, tags = "train"),
         skip      = p_lgl(default = FALSE, tags = "train"),
         subset    = p_uty(tags = "train"),
-        trace     = p_lgl(default = TRUE, tags = "train")
+        trace     = p_lgl(default = TRUE, tags = "train"),
+        formula   = p_uty(tags = "train")
       )
       ps$values = list(size = 3L)
 
       super$initialize(
         id = "classif.nnet",
         packages = c("mlr3learners", "nnet"),
-        feature_types = c("numeric", "factor", "ordered"),
+        feature_types = c("numeric", "factor", "ordered", "integer"),
         predict_types = c("prob", "response"),
         param_set = ps,
         properties = c("twoclass", "multiclass", "weights"),
@@ -68,9 +72,11 @@ LearnerClassifNnet = R6Class("LearnerClassifNnet",
       if ("weights" %in% task$properties) {
         pv = insert_named(pv, list(weights = task$weights$weight))
       }
-      f = task$formula()
+      if (is.null(pv$formula)) {
+        pv$formula = task$formula()
+      }
       data = task$data()
-      invoke(nnet::nnet.formula, formula = f, data = data, .args = pv)
+      invoke(nnet::nnet.formula, data = data, .args = pv)
     },
 
     .predict = function(task) {

R/LearnerRegrNnet.R

@@ -17,6 +17,9 @@
 #'   - Adjusted default: 3L.
 #'   - Reason for change: no default in `nnet()`.
 #'
+#' @section Custom mlr3 parameters:
+#' - `formula`: if not provided, the formula is set to `task$formula()`.
+#'
 #' @references
 #' `r format_bib("ripley_1996")`
 #'
@@ -46,14 +49,15 @@ LearnerRegrNnet = R6Class("LearnerRegrNnet",
         size      = p_int(0L, default = 3L, tags = "train"),
         skip      = p_lgl(default = FALSE, tags = "train"),
         subset    = p_uty(tags = "train"),
-        trace     = p_lgl(default = TRUE, tags = "train")
+        trace     = p_lgl(default = TRUE, tags = "train"),
+        formula   = p_uty(tags = "train")
       )
       ps$values = list(size = 3L)
 
       super$initialize(
         id = "regr.nnet",
         packages = c("mlr3learners", "nnet"),
-        feature_types = c("numeric", "factor", "ordered"),
+        feature_types = c("numeric", "factor", "ordered", "integer"),
         predict_types = c("response"),
         param_set = ps,
         properties = c("weights"),
@@ -68,10 +72,12 @@ LearnerRegrNnet = R6Class("LearnerRegrNnet",
       if ("weights" %in% task$properties) {
         pv = insert_named(pv, list(weights = task$weights$weight))
       }
-      f = task$formula()
+      if (is.null(pv$formula)) {
+        pv$formula = task$formula()
+      }
       data = task$data()
       # force linout = TRUE for regression
-      invoke(nnet::nnet.formula, formula = f, data = data, linout = TRUE, .args = pv)
+      invoke(nnet::nnet.formula, data = data, linout = TRUE, .args = pv)
     },
 
     .predict = function(task) {

inst/paramtest/test_paramtest_classif.nnet.R

@@ -7,7 +7,6 @@ test_that("classif.nnet", {
     "x", # handled via mlr3
     "y", # handled via mlr3
     "weights", # handled via mlr3
-    "formula", # handled via mlr3
     "data", # handled via mlr3
     "entropy", # automatically set to TRUE if two-class task
     "softmax", # automatically set to TRUE if multi-class task

inst/paramtest/test_paramtest_regr.nnet.R

@@ -7,7 +7,6 @@ test_that("regr.nnet", {
     "x", # handled via mlr3
     "y", # handled via mlr3
     "weights", # handled via mlr3
-    "formula", # handled via mlr3
     "data", # handled via mlr3
     "linout", # automatically set to TRUE, since it's the regression learner
     "entropy", # mutually exclusive with linout