Skip to contents

The record of what ran: every config value resolved, an origin saying where each came from, and a provenance block. Derived on demand from the configs the object already holds.

Usage

record(x, ...)

Arguments

x

Fitted model object.

...

Passed to methods.

Value

Named list, conforming to the family's record.json.

Author

EDG

Examples

mod <- train(iris, hyperparameters = setup_CART())
#> 2026-10-20 09:08:00 
#> Checking data is ready for training...
#>  
#> ✔ 
#> [check_supervised]
#> 2026-10-20 09:08:00 
#> ▶
#>  [train]
#> 2026-10-20 09:08:00 
#> Training set: 150 cases x 4 features.
#>  [summarize_supervised]
#> 2026-10-20 09:08:00 
#> // CPU | future (mirai_multisession) | 7 workers: algorithm 1 thread, tuning 1, outer resampling 1
#>  [msg_resources]
#> 2026-10-20 09:08:00 
#> Shared memory (auto): not sharing training data (7.3 kB) -- this run transfers nothing to workers.
#>  [report_shared_memory]
#> 2026-10-20 09:08:00 
#> Training CART Classification...
#>  [train]
#> 2026-10-20 09:08:00 
#> Checking data is ready for training...
#>  
#> ✔ 
#> [check_supervised]
#> 
#> <Classification>
#> CART (CART decision tree (rpart))
#> 
#>   <Training Classification Metrics>
#>                      Predicted
#>           Reference  setosa  versicolor  virginica  
#>              setosa      50           0          0
#>          versicolor       0          47          3
#>           virginica       0           1         49
#> 
#>                      Overall  
#>   Balanced Accuracy  0.973  
#>                  F1  0.973  
#>            Accuracy  0.973  
#>                      Setosa  Versicolor  Virginica  
#>         Sensitivity  1.000   0.940       0.980    
#>         Specificity  1.000   0.990       0.970    
#>   Balanced Accuracy  1.000   0.965       0.975    
#>                 PPV  1.000   0.979       0.942    
#>                 NPV  1.000   0.971       0.990    
#>                  F1  1.000   0.959       0.961    
#> 
#> 2026-10-20 09:08:00 
#> Done in 0.03 seconds.
#>  [train]
names(record(mod))
#>  [1] "$schema"                 "outcome"                
#>  [3] "features"                "weights"                
#>  [5] "positive_class"          "question"               
#>  [7] "outdir"                  "verbosity"              
#>  [9] "dat_training_path"       "dat_validation_path"    
#> [11] "dat_test_path"           "character2factor"       
#> [13] "preprocessor_config"     "decomposition_config"   
#> [15] "hyperparameters"         "tuner_config"           
#> [17] "outer_resampling_config" "execution_config"       
#> [19] "origin"                  "folds"                  
#> [21] "metrics"                 "metrics_sd"             
#> [23] "provenance"              "session"