Skip to contents

ledgr_param_grid() creates a validated parameter-grid object for sweep candidate identity. The grid stores parameter combinations and labels; it does not execute candidates by itself.

Usage

ledgr_param_grid(...)

Arguments

...

Parameter-list entries.

Value

A ledgr_param_grid object with labels and params fields.

Details

Each argument must be a JSON-safe list of strategy parameters. Named arguments preserve their names as grid labels. Unnamed arguments receive a stable grid_<hash> label derived from ledgr's canonical JSON encoding of the parameter list. Grid labels are labels only; they are not run IDs.

Indicator parameters can live in the same list as strategy parameters when an experiment uses features = function(params) .... There is no separate indicator-sweep API in v0.1.8.

Articles

Exploratory sweeps and promotion: vignette("sweeps", package = "ledgr") system.file("doc", "sweeps.html", package = "ledgr")

Examples

grid <- ledgr_param_grid(
  conservative = list(threshold = 0.01, qty = 1),
  list(threshold = 0.02, qty = 2)
)
grid$labels
#> [1] "conservative"      "grid_786fd44ea0bc"
grid$params
#> [[1]]
#> [[1]]$threshold
#> [1] 0.01
#> 
#> [[1]]$qty
#> [1] 1
#> 
#> 
#> [[2]]
#> [[2]]$threshold
#> [1] 0.02
#> 
#> [[2]]$qty
#> [1] 2
#> 
#>