test interactions with butcher (#28)

* bundle both fitted and original recipe

see `workflows::extract_recipe.workflow` definition for locations.

the workflows bundler tripped up at predict time with a trained recipe because only the recipe _specification_ had been effectively bundled

* test interaction with butcher

* add butcher to Suggests

* test butcher interaction conditionally

* add roxygen template on butcher and bundle

* Add link, tiny edits

* Redocument

Co-authored-by: Julia Silge <[email protected]>

Author: simonpcouch

DESCRIPTION

@@ -30,6 +30,7 @@ Imports:
     utils
 Suggests:
     bonsai,
+    butcher,
     caret,
     callr,
     covr,

R/bundle_caret.R

@@ -12,6 +12,7 @@
 #' @details Primarily, these methods call [bundle()] on the output of
 #'   `train_model_object$finalModel`. See the class of the output of that
 #'   slot for more details on the bundling method for that object.
+#' @template butcher_details
 #' @examplesIf rlang::is_installed("caret")
 #' # fit model and bundle ------------------------------------------------
 #' library(caret)

R/bundle_embed.R

@@ -10,6 +10,7 @@
 #'   from [embed][embed::step_umap].
 #' @template param_unused_dots
 #' @seealso This method wraps [uwot::save_uwot()] and [uwot::load_uwot()].
+#' @template butcher_details
 #' @examplesIf rlang::is_installed("recipes") && rlang::is_installed("embed")
 #' # fit model and bundle ------------------------------------------------
 #' library(recipes)

R/bundle_parsnip.R

@@ -12,6 +12,7 @@
 #' @details Primarily, these methods call [bundle()] on the output of
 #'   [parsnip::extract_fit_engine()]. See the class of the output of that
 #'   function for more details on the bundling method for that object.
+#' @template butcher_details
 #' @examplesIf rlang::is_installed("parsnip") && rlang::is_installed("xgboost")
 #' # fit model and bundle ------------------------------------------------
 #' library(parsnip)

R/bundle_workflows.R

@@ -12,6 +12,8 @@
 #'
 #' @details This bundler wraps [bundle.model_fit()] and [bundle.recipe()].
 #'
+#' @template butcher_details
+#'
 #' @examplesIf rlang::is_installed(c("workflows", "parsnip", "recipes", "xgboost"))
 #' # fit model and bundle ------------------------------------------------
 #' library(workflows)
@@ -50,12 +52,14 @@ bundle.workflow <- function(x, ...) {
 
   res <- swap_element(x, "fit", "fit")
   res <- swap_element(res, "pre", "actions", "recipe", "recipe")
+  res <- swap_element(res, "pre", "mold", "blueprint", "recipe")
 
   bundle_constr(
     object = res,
     situate = situate_constr(function(object) {
       res <- bundle::swap_element(object, "fit", "fit")
       res <- bundle::swap_element(res, "pre", "actions", "recipe", "recipe")
+      res <- bundle::swap_element(res, "pre", "mold", "blueprint", "recipe")
 
       structure(res, class = !!class(x))
     }),

R/bundle_xgboost.R

@@ -13,6 +13,7 @@
 #' @seealso This method adapts the xgboost internal functions
 #'   `predict.xgb.Booster.handle()` and `xgb.handleToBooster()`, as well
 #'   as  [xgboost::xgb.serialize()].
+#' @template butcher_details
 #' @examplesIf rlang::is_installed("xgboost")
 #' # fit model and bundle ------------------------------------------------
 #' library(xgboost)

man-roxygen/butcher_details.R

@@ -0,0 +1,17 @@
+#' @section bundle and butcher:
+#' The [butcher](https://butcher.tidymodels.org/) package allows you to remove
+#' parts of a fitted model object that are not needed for prediction.
+#'
+#' This bundle method is compatible with pre-butchering. That is, for a
+#' fitted model `x`, you can safely call:
+#'
+#' ```
+#' res <-
+#'   x %>%
+#'   butcher() %>%
+#'   bundle()
+#' ```
+#'
+#' and predict with the output of `unbundle(res)` in a new R session.
+#'
+#' @md