Select one sweep candidate for promotion

Selects a single row from a sweep result table and packages its params, seed, and provenance for promotion or inspection.

Usage

ledgr_candidate(results, which = 1L, allow_failed = FALSE)

Arguments

results

A ledgr_sweep_results object or tibble-like object with run_id, params, execution_seed, and provenance columns.

which

Candidate selector. A character scalar selects by run_id; an integer-like scalar selects by row position.

allow_failed

Logical. Failed candidates error by default.

Value

A ledgr_sweep_candidate object.

Details

The returned candidate carries selection_view, the tibble-like view passed to ledgr_candidate(). Promotion-context storage uses that view to record the filtered/sorted candidate table the user selected from. ledgr_candidate() is the supported way to extract params, execution seed, and row-level provenance for promotion. It avoids making users manually pull params[[1]] and execution_seed from a tibble row.

Articles

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