Advanced Controls for Custom Model Creation

Source: R/custom_model_authoring.R

Most callers can omit these controls. No provider calls, model execution or files are created by this constructor. Construct a new control rather than mutating one; explicit-setting markers are checked for consistency.

custom_model_control(
  max_attempts = 3L,
  validation_budget = 60,
  package_policy = "installed_finnts",
  required_properties = character(),
  forecast_approach = NULL
)

Arguments

max_attempts

Total proposals per phase, including the initial proposal; an integer from 1 through 3.

validation_budget

Elapsed validation budget in seconds, greater than zero and at most 120. Default 60; not a hard timeout or provider-call limit.

package_policy

Generated-code package boundary: "installed_finnts" (default) permits installed direct FinnTS dependencies and its existing base/recommended allowance; "base_only" permits base R. No installation.

required_properties

Mandatory checks chosen from constant_forecast, target_scale_equivariant, independent_series, fixed_window, and relative_calendar. Default none; choose only properties required by the rule.

forecast_approach

NULL inherits a prepared run, or uses "bottoms_up" for raw data. Other choices are "standard_hierarchy" and "grouped_hierarchy"; both require local, univariate rules on the raw C1 recipe and a mixed custom/FinnTS pool with reconciliation during forecast execution.

Value

A validated finnts_custom_model_control with five named settings. Invalid settings or stale explicit-setting markers raise authoring errors.

Examples

custom_model_control()
#> $max_attempts
#> [1] 3
#> 
#> $validation_budget
#> [1] 60
#> 
#> $package_policy
#> [1] "installed_finnts"
#> 
#> $required_properties
#> character(0)
#> 
#> $forecast_approach
#> NULL
#> 
#> attr(,"class")
#> [1] "finnts_custom_model_control"
#> attr(,"supplied")
#> character(0)
custom_model_control(max_attempts = 2L, package_policy = "base_only")
#> $max_attempts
#> [1] 2
#> 
#> $validation_budget
#> [1] 60
#> 
#> $package_policy
#> [1] "base_only"
#> 
#> $required_properties
#> character(0)
#> 
#> $forecast_approach
#> NULL
#> 
#> attr(,"class")
#> [1] "finnts_custom_model_control"
#> attr(,"supplied")
#> [1] "max_attempts"   "package_policy"