tune (version 1.0.0)

finalize_model: Splice final parameters into objects

Description

The finalize_* functions take a list or tibble of tuning parameter values and update objects with those values.

Usage

finalize_model(x, parameters)
finalize_recipe(x, parameters)
finalize_workflow(x, parameters)

Value

An updated version of x.

Arguments

x

A recipe, parsnip model specification, or workflow.

parameters

A list or 1-row tibble of parameter values. Note that the column names of the tibble should be the id fields attached to tune(). For example, in the Examples section below, the model has tune("K"). In this case, the parameter tibble should be "K" and not "neighbors".

Examples

# \donttest{
data("example_ames_knn")

library(parsnip)
knn_model <-
  nearest_neighbor(
    mode = "regression",
    neighbors = tune("K"),
    weight_func = tune(),
    dist_power = tune()
  ) %>%
  set_engine("kknn")

lowest_rmse <- select_best(ames_grid_search, metric = "rmse")
lowest_rmse

knn_model
finalize_model(knn_model, lowest_rmse)
# }