callback_batch {bbotk} | R Documentation |
Create Batch Optimization Callback
Description
Function to create a CallbackBatch.
Optimization callbacks can be called from different stages of optimization process.
The stages are prefixed with on_*
.
Start Optimization - on_optimization_begin Start Optimizer Batch - on_optimizer_before_eval - on_optimizer_after_eval End Optimizer Batch - on_result - on_optimization_end End Optimization
See also the section on parameters for more information on the stages. A optimization callback works with ContextBatch.
Usage
callback_batch(
id,
label = NA_character_,
man = NA_character_,
on_optimization_begin = NULL,
on_optimizer_before_eval = NULL,
on_optimizer_after_eval = NULL,
on_result = NULL,
on_optimization_end = NULL,
fields = list()
)
Arguments
id |
( |
label |
( |
man |
( |
on_optimization_begin |
( |
on_optimizer_before_eval |
( |
on_optimizer_after_eval |
( |
on_result |
( |
on_optimization_end |
( |
fields |
(list of |
Details
A callback can write data to its state ($state
), e.g. settings that affect the callback itself.
The ContextBatch allows to modify the instance, archive, optimizer and final result.
Examples
# write archive to disk
callback_batch("bbotk.backup",
on_optimization_end = function(callback, context) {
saveRDS(context$instance$archive, "archive.rds")
}
)