write_record: Write a run record to a JSON file

In rtemis: Schema-Driven Machine Learning and Visualization

Write a run record to a JSON file

Description

A record states what a run actually did: every value resolved, where each one came from, and what produced it. A separate function from write_config, since the two artifacts answer different questions.

Usage

write_record(x, file, overwrite = FALSE, verbosity = 1L)

Arguments

x	Fitted model object, or a record list from record.
file	Character: Path to write to.
overwrite	Logical: If TRUE, overwrite an existing file.
verbosity	Integer: Verbosity level.

Details

Three things distinguish a record from the config it came from:

• Every field is present and resolved. A config omits what the user did not set, so a reader applies defaults; a record leaves nothing to them, and writes an unset field as an explicit null.

• Each value says where it came from, in a parallel origin map: user, default, derived (computed from the data), tuned, or unset for a field a failed run never reached.

• provenance records the rtemis and R versions, platform, timing, outcome, and a fingerprint of the data.

For a supervised run the top level is what was asked for and folds is what ran, one entry per model fitted – outer resampling resolves different values in each fold, so a single resolved value at the top level would state something no fold did.

A supervised record also states what the run scored. metrics holds each sample's headline row as a flat metric-to-value map, averaged across outer resamples, with metrics_sd beside it for the spread (null for a single fit, which has none). The full metrics – the confusion matrix, the per-class rows – are in each fold's own metrics. The flat block exists so that "was this model any good?" is one lookup in one file, with no averaging and no R, which is what makes a directory of records rankable.

train, decomp and cluster call this automatically when given an outdir. A record is not a config: feeding one to read_config is an error, since its resolved values would silently pin settings the new call should decide for itself.

Unlike a config, a record is not compacted: an unset field is written as an explicit null, so nothing in it falls back to a reader's defaults.

Value

x, invisibly.

Author(s)

EDG

Examples

## Not run: 
mod <- train(iris, hyperparameters = setup_CART())
write_record(mod, "train_CART.record.json")

## End(Not run)

rtemis documentation built on Oct. 20, 2026, 1:06 a.m.