fix R CMD check

DESCRIPTION

@@ -21,7 +21,6 @@ BugReports: https://github.com/mlverse/tabnet/issues
 Depends:
     R (>= 3.6)
 Imports: 
-    cli,
     coro,
     data.tree,
     dials,
@@ -46,6 +45,7 @@ Imports:
     withr,
     zeallot
 Suggests: 
+    cli,
     knitr,
     modeldata,
     patchwork,

R/dials.R

@@ -3,6 +3,11 @@ check_dials <- function() {
     stop("Package \"dials\" needed for this function to work. Please install it.", call. = FALSE)
 }
 
+check_cli <- function() {
+  if (!requireNamespace("cli", quietly = TRUE))
+    stop("Package \"cli\" needed for this function to work. Please install it.", call. = FALSE)
+}
+
 
 
 #' Parameters for the tabnet model
@@ -127,57 +132,61 @@ num_steps <- function(range = c(3L, 10L), trans = NULL) {
   )
 }
 
-#' @noRd
+#' Non-tunable parameters for the tabnet model
+#'
+#' @param range unused
+#' @param trans unused
+#' @rdname tabnet_non_tunable
 #' @export
 cat_emb_dim <- function(range = NULL, trans = NULL) {
-  check_dials()
+  check_cli()
   cli::cli_abort("{.var cat_emb_dim} cannot be used as a {.fun tune} parameter yet.")
 }
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 checkpoint_epochs <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 drop_last <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 encoder_activation <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 lr_scheduler <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 mlp_activation <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 mlp_hidden_multiplier <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 num_independent_decoder <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 num_shared_decoder <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 optimizer <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 penalty <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 verbose <- cat_emb_dim
 
-#' @noRd
+#' @rdname tabnet_non_tunable
 #' @export
 virtual_batch_size <- cat_emb_dim

R/parsnip.R

@@ -427,6 +427,11 @@ add_parsnip_tabnet <- function() {
 #'   for this model are "unknown", "regression", or "classification".
 #' @inheritParams tabnet_config
 #' @inheritParams tabnet_fit
+#' @param rate_decay multiplies the initial learning rate by `rate_decay` every
+#'   `rate_step_size` epochs. Unused if `lr_scheduler` is a `torch::lr_scheduler`
+#'   or `NULL`.
+#' @param rate_step_size the learning rate scheduler step size. Unused if
+#'   `lr_scheduler` is a `torch::lr_scheduler` or `NULL`.
 #'
 #' @inheritSection tabnet_fit Threading
 #' @seealso tabnet_fit

inst/WORDLIST

@@ -15,7 +15,6 @@ Pretrain
 Sercan
 TabNet
 TabNet's
-adam
 ai
 al
 ames
@@ -37,6 +36,7 @@ ggplot
 interpretable
 mse
 nn
+num
 orginal
 overfit
 overfits
@@ -49,4 +49,5 @@ sparsemax
 subprocesses
 th
 tidymodels
+tunable
 zeallot