docs(callbacks): add examples

R/CallbackSetCheckpoint.R

@@ -19,6 +19,18 @@
 #' @family Callback
 #' @export
 #' @include CallbackSet.R
+#' 
+#' @examplesIf torch::torch_is_installed()
+#' cb = t_clbk("checkpoint", freq = 1)
+#' task = tsk("iris")
+#' 
+#' pth = tempfile()
+#' learner = lrn("classif.mlp", epochs = 3, batch_size = 1, callbacks = cb)
+#' learner$param_set$set_values(cb.checkpoint.path = pth)
+#' 
+#' learner$train(task)
+#' 
+#' list.files(pth)
 CallbackSetCheckpoint = R6Class("CallbackSetCheckpoint",
   inherit = CallbackSet,
   lock_objects = FALSE,

R/CallbackSetHistory.R

@@ -9,6 +9,20 @@
 #'
 #' @export
 #' @include CallbackSet.R
+#' @examplesIf torch::torch_is_installed()
+#'
+#' cb = t_clbk("history")
+#' task = tsk("iris")
+#'
+#' learner = lrn("classif.mlp", epochs = 3, batch_size = 1,
+#'   callbacks = t_clbk("history"), validate = 0.3)
+#' learner$param_set$set_values(
+#'   measures_train = msrs(c("classif.acc", "classif.ce")),
+#'   measures_valid = msr("classif.ce")
+#' )
+#' learner$train(task)
+#'
+#' print(learner$model$callbacks$history)
 CallbackSetHistory = R6Class("CallbackSetHistory",
   inherit = CallbackSet,
   lock_objects = FALSE,

R/CallbackSetProgress.R

@@ -8,6 +8,17 @@
 #' @family Callback
 #' @include CallbackSet.R
 #' @export
+#' @examplesIf torch::torch_is_installed()
+#' task = tsk("iris")
+#'
+#' learner = lrn("classif.mlp", epochs = 10, batch_size = 1, 
+#'   callbacks = t_clbk("progress"), validate = 0.3)
+#' learner$param_set$set_values(
+#'   measures_train = msrs(c("classif.acc", "classif.ce")),
+#'   measures_valid = msr("classif.ce")
+#' )
+#'
+#' learner$train(task)
 CallbackSetProgress = R6Class("CallbackSetProgress",
   inherit = CallbackSet,
   lock_objects = FALSE,

R/CallbackSetUnfreeze.R

@@ -14,6 +14,21 @@
 #' @family Callback
 #' @export
 #' @include CallbackSet.R
+#' @examplesIf torch::torch_is_installed()
+#' task = tsk("iris")
+#' cb = t_clbk("unfreeze")
+#' mlp = lrn("classif.mlp", callbacks = cb,
+#'  cb.unfreeze.starting_weights = select_invert(
+#'    select_name(c("0.weight", "3.weight", "6.weight", "6.bias"))
+#'  ),
+#'  cb.unfreeze.unfreeze = data.table(
+#'    epoch = c(2, 5),
+#'    weights = list(select_name("0.weight"), select_name(c("3.weight", "6.weight")))
+#'  ),
+#'  epochs = 6, batch_size = 150, neurons = c(1, 1, 1)
+#' )
+#'
+#' mlp$train(task)
 CallbackSetUnfreeze = R6Class("CallbackSetUnfreeze",
   inherit = CallbackSet,
   lock_objects = FALSE,