add extract_fit_time

DESCRIPTION

@@ -21,10 +21,10 @@ Imports:
     cli (>= 3.3.0),
     generics (>= 0.1.2),
     glue (>= 1.6.2),
-    hardhat (>= 1.2.0),
+    hardhat (>= 1.3.1.9000),
     lifecycle (>= 1.0.3),
     modelenv (>= 0.1.0),
-    parsnip (>= 1.2.0),
+    parsnip (>= 1.2.1.9000),
     rlang (>= 1.0.3),
     tidyselect (>= 1.2.0),
     vctrs (>= 0.4.1)
@@ -35,7 +35,7 @@ Suggests:
     knitr,
     magrittr,
     modeldata (>= 1.0.0),
-    recipes (>= 1.0.0),
+    recipes (>= 1.0.10.9000),
     rmarkdown,
     testthat (>= 3.0.0)
 VignetteBuilder: 
@@ -46,6 +46,10 @@ Config/Needs/website:
     tidyr,
     tidyverse/tidytemplate,
     yardstick
+Remotes:
+    tidymodels/hardhat,
+    tidymodels/recipes,
+    tidymodels/parsnip
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)

NAMESPACE

@@ -4,6 +4,7 @@ S3method(.censoring_weights_graf,workflow)
 S3method(augment,workflow)
 S3method(extract_fit_engine,workflow)
 S3method(extract_fit_parsnip,workflow)
+S3method(extract_fit_time,workflow)
 S3method(extract_mold,workflow)
 S3method(extract_parameter_dials,workflow)
 S3method(extract_parameter_set_dials,workflow)
@@ -29,6 +30,7 @@ export(add_variables)
 export(control_workflow)
 export(extract_fit_engine)
 export(extract_fit_parsnip)
+export(extract_fit_time)
 export(extract_mold)
 export(extract_parameter_dials)
 export(extract_parameter_set_dials)
@@ -62,6 +64,7 @@ importFrom(generics,tunable)
 importFrom(generics,tune_args)
 importFrom(hardhat,extract_fit_engine)
 importFrom(hardhat,extract_fit_parsnip)
+importFrom(hardhat,extract_fit_time)
 importFrom(hardhat,extract_mold)
 importFrom(hardhat,extract_parameter_dials)
 importFrom(hardhat,extract_parameter_set_dials)

NEWS.md

@@ -19,6 +19,8 @@
 * `add_recipe()` will now error informatively when supplied a trained recipe
   (#179).
 
+* New `extract_fit_time()` method has been added that return the time it took to train the workflow. (#191)
+
 # workflows 1.1.3
 
 * The workflows methods for `generics::tune_args()` and `generics::tunable()`

R/extract.R

@@ -27,11 +27,18 @@
 #'
 #' - `extract_parameter_set_dials()` returns a set of dials parameter objects.
 #'
+#' - `extract_fit_time()` returns a tibble with elapsed fit times. The fit
+#'   times correspond to the time for the parsnip engine or recipe steps to fit
+#'   (or their sum if `summarize = TRUE`) and do not include other portions of
+#'   the elapsed time in [workflows::fit.workflow()].
+#'
 #' @param x A workflow
 #'
 #' @param estimated A logical for whether the original (unfit) recipe or the
 #' fitted recipe should be returned. This argument should be named.
 #' @param parameter A single string for the parameter ID.
+#' @param summarize A logical for whether the elapsed fit time should be returned as a
+#' single row or multiple rows.
 #' @param ... Not currently used.
 #'
 #' @details
@@ -212,3 +219,28 @@ extract_parameter_set_dials.workflow <- function(x, ...) {
 extract_parameter_dials.workflow <- function(x, parameter, ...) {
   extract_parameter_dials(extract_parameter_set_dials(x), parameter)
 }
+
+#' @export
+#' @rdname extract-workflow
+extract_fit_time.workflow <- function(x, summarize = TRUE, ...) {
+  if (has_preprocessor_recipe(x)) {
+    preprocessor <- extract_fit_time(extract_recipe(x), summarize = summarize)
+    preprocessor <- vctrs::vec_cbind(stage = "preprocess", preprocessor)
+  }
+
+  res <- extract_fit_time(extract_fit_parsnip(x))
+  res <- vctrs::vec_cbind(stage = "model", res)
+
+  if (has_preprocessor_recipe(x)) {
+    res <- vctrs::vec_rbind(preprocessor, res)
+  }
+
+  if (summarize) {
+    res$stage <- "workflow"
+    res$stage_id <- "workflow"
+    res$elapsed <- sum(res$elapsed)
+    res <- res[1, ]
+  }
+
+  res
+}

R/reexports.R

@@ -29,3 +29,7 @@ hardhat::extract_parameter_set_dials
 #' @importFrom hardhat extract_parameter_dials
 #' @export
 hardhat::extract_parameter_dials
+#'
+#' @importFrom hardhat extract_fit_time
+#' @export
+hardhat::extract_fit_time

tests/testthat/test-extract.R

@@ -353,3 +353,41 @@ test_that("extract single parameter from workflow with tunable recipe and model"
     NA
   )
 })
+
+# ------------------------------------------------------------------------------
+# extract_recipe()
+
+test_that("extract_fit_time() works", {
+  skip_if_not_installed("recipes")
+  rec_spec <- recipes::recipe(mpg ~ ., data = mtcars) %>%
+    recipes::step_scale(recipes::all_numeric_predictors(), id = "scale") %>%
+    recipes::step_center(recipes::all_numeric_predictors(), id = "center")
+
+  lm_spec <- parsnip::linear_reg()
+
+  wf <- workflow(rec_spec, lm_spec) %>% fit(mtcars)
+
+  res <- extract_fit_time(wf)
+
+  expect_s3_class(res, "tbl_df")
+  expect_identical(names(res), c("stage", "stage_id", "elapsed"))
+  expect_identical(res$stage, "workflow")
+  expect_identical(res$stage_id, "workflow")
+  expect_true(is.double(res$elapsed))
+  expect_true(res$elapsed >= 0)
+
+  res <- extract_fit_time(wf, summarize = FALSE)
+
+  expect_s3_class(res, "tbl_df")
+  expect_identical(names(res), c("stage", "stage_id", "elapsed"))
+  expect_identical(
+    res$stage,
+    c("preprocess", "preprocess", "preprocess", "preprocess", "model")
+  )
+  expect_identical(
+    res$stage_id,
+    c("prep.scale", "bake.scale", "prep.center", "bake.center", "linear_reg")
+  )
+  expect_true(is.double(res$elapsed))
+  expect_true(all(res$elapsed >= 0))
+})