control_modeltime: Control aspects of the training process

Description Usage Arguments Value See Also Examples

Description

These functions are matched to the associated training functions:

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
control_refit(verbose = FALSE, allow_par = FALSE, cores = -1, packages = NULL)

control_fit_workflowset(
  verbose = FALSE,
  allow_par = FALSE,
  cores = -1,
  packages = NULL
)

control_nested_fit(
  verbose = FALSE,
  allow_par = FALSE,
  cores = -1,
  packages = NULL
)

control_nested_refit(
  verbose = FALSE,
  allow_par = FALSE,
  cores = -1,
  packages = NULL
)

control_nested_forecast(
  verbose = FALSE,
  allow_par = FALSE,
  cores = -1,
  packages = NULL
)

Arguments

verbose

Logical to control printing.

allow_par

Logical to allow parallel computation. Default: FALSE (single threaded).

cores

Number of cores for computation. If -1, uses all available physical cores. Default: -1.

packages

An optional character string of additional R package names that should be loaded during parallel processing.

  • Packages in your namespace are loaded by default

  • Key Packages are loaded by default: tidymodels, parsnip, modeltime, dplyr, stats, lubridate and timetk.

Value

A List with the control settings.

See Also

[parallel_stop())]: R:parallel_stop()) [modeltime_refit()]: R:modeltime_refit() [modeltime_fit_workflowset()]: R:modeltime_fit_workflowset() [modeltime_nested_fit()]: R:modeltime_nested_fit() [modeltime_nested_refit()]: R:modeltime_nested_refit()

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# No parallel processing by default
control_refit()

# Allow parallel processing
control_refit(allow_par = TRUE)

# Set verbosity to show additional training information
control_refit(verbose = TRUE)

# Add additional packages used during modeling in parallel processing
# - This is useful if your namespace does not load all needed packages
#   to run models.
# - An example is if I use `temporal_hierarchy()`, which depends on the `thief` package
control_refit(allow_par = TRUE, packages = "thief")

modeltime documentation built on Oct. 18, 2021, 5:08 p.m.