Setup Execution Configuration

Usage

setup_ExecutionConfig(
  backend = c("future", "mirai", "none"),
  n_workers = NULL,
  future_plan = NULL,
  on_error = c("continue", "stop", "stop_outer")
)

Arguments

backend: Character {"future", "mirai", "none"}: Execution backend.
n_workers: Integer [1, Inf): Number of workers for parallel execution. Only used if backend is "future" or "mirai". Set this to an appropriate number depending on your system.
future_plan: Optional Character: Future plan to use if backend is "future".
on_error: Character {"continue", "stop", "stop_outer"}: Failure policy. "continue" makes grid cells and unscorable hyperparameter combinations non-fatal (recorded, warned, and excluded), failing only when nothing is scorable or the final model fails; "stop" aborts on any error; "stop_outer" tolerates grid-cell failures but aborts on an outer-fold failure.

Value

ExecutionConfig object.

Author

EDG

Examples

setup_ExecutionConfig(backend = "future", n_workers = 4L, future_plan = "multisession")
#> <ExecutionConfig>
#>     backend: <chr> future
#>   n_workers: <int> 4
#> future_plan: <chr> multisession
#>    on_error: <chr> continue
#>