Merge pull request #25 from tidymodels/tuning-updates

Tuning updates

Author: topepo

DESCRIPTION

@@ -3,7 +3,7 @@ Version: 0.0.3.9000
 Title: Extra Recipes for Encoding Categorical Predictors
 Description: Predictors can be converted to one or more numeric representations using simple generalized linear models <arXiv:1611.09477> or nonlinear models <arXiv:1604.06737>. All encoding methods are supervised.
 Authors@R: c(
-    person("Max", "Kuhn", , "[email protected]", c("aut", "cre")),
+    person(given = "Max", family = "Kuhn", email = "[email protected]", role = c("aut", "cre")),
     person("RStudio", role = "cph"))
 Depends: 
     R (>= 3.1),

NAMESPACE

@@ -38,6 +38,9 @@ export(tidy.step_lencode_bayes)
 export(tidy.step_lencode_glm)
 export(tidy.step_lencode_mixed)
 export(tidy.step_umap)
+export(tunable.step_embed)
+export(tunable.step_umap)
+export(tunable.step_woe)
 import(rlang)
 importFrom(dplyr,"%>%")
 importFrom(dplyr,arrange)

NEWS.md

@@ -1,3 +1,10 @@
+# `embed` 0.0.4
+
+ * Methods were added for a future generic called `tunable()`. This outlines which parameters in a step can/could be tuned.
+
+ * Small updates to work with different versions of `tidyr`.  
+ 
+
 # `embed` 0.0.3
 
 ## New Steps

R/tunable.R

@@ -0,0 +1,55 @@
+#' tunable methods for embed
+#'
+#' These functions define what parameters _can_ be tuned for specific steps.
+#'  They also define the recommended objects from the `dials` package that can
+#'  be used to generate new parameter values and other characteristics.
+#' @param x A recipe step object
+#' @param ... Not used.
+#' @return A tibble object.
+#' @keywords internal
+#' @export
+tunable.step_embed <- function(x, ...) {
+  tibble::tibble(
+    name = c("num_terms", "hidden_units"),
+    call_info = list(
+      list(pkg = "dials", fun = "num_terms", range = c(2, 10)),
+      list(pkg = "dials", fun = "hidden_units", range = c(0, 10))
+    ),
+    source = "recipe",
+    component = "step_embed",
+    component_id = x$id
+  )
+}
+
+
+#' @export
+#' @rdname tunable.step_embed
+tunable.step_umap <- function(x, ...) {
+  tibble::tibble(
+    name = c("num_comp", "neighbors", "min_dist", "learn_rate", "epochs"),
+    call_info = list(
+      list(pkg = "dials", fun = "num_comp", range = c(1, 10)),
+      list(pkg = "dials", fun = "neighbors", range = c(5, 25)),
+      list(pkg = "dials", fun = "min_dist", range = c(-4, 0)),
+      list(pkg = "dials", fun = "learn_rate"),
+      list(pkg = "dials", fun = "epochs", range = c(100, 700))
+    ),
+    source = "recipe",
+    component = "step_umap",
+    component_id = x$id
+  )
+}
+
+#' @export
+#' @rdname tunable.step_embed
+tunable.step_woe <- function(x, ...) {
+  tibble::tibble(
+    name = "Laplace",
+    call_info = list(
+      list(pkg = "dials", fun = "Laplace")
+    ),
+    source = "recipe",
+    component = "step_woe",
+    component_id = x$id
+  )
+}