R/gcae_train_more.R

In richelbilderbeek/gcaer: Interface to GCAE

#' Continue training a model, and save its state at certain epochs to disk.
#'
#' Continue training a model, and save its state at certain epochs to disk.
#' use the GCAE command-line interface.
#'
#' To simply run the model from epoch zero,
#' use \link{gcae_train}
#' @inheritParams default_params_doc
#' @return full paths to the created files
#' @seealso
#' Use \link{gcae_train} to do train from epoch zero to end in one go.
#' Use \link{create_gcae_train_more_args} to get the command-line
#' arguments.
#' @author Richèl J.C. Bilderbeek
#' @export
gcae_train_more <- function(
  gcae_setup = create_test_gcae_setup(),
  resume_from = 0,
  epochs = 1,
  save_interval = 1,
  gcae_options = create_gcae_options(),
  verbose = FALSE
) {
  gcaer::check_gcae_setup(gcae_setup)
  gcaer::check_resume_from(resume_from)
  gcaer::check_epochs(epochs)
  testthat::expect_true(epochs >= 1)
  gcaer::check_save_interval(save_interval)
  gcaer::check_gcae_options(gcae_options)
  plinkr::check_verbose(verbose)

  gcaer::check_gcae_train_files_are_present(
    gcae_setup = gcae_setup,
    gcae_options = gcae_options
  )


  args <- gcaer::create_gcae_train_more_args(
    gcae_setup = gcae_setup,
    resume_from = resume_from,
    epochs = epochs,
    save_interval = save_interval
  )
  dir.create(
    gcae_setup$trainedmodeldir,
    showWarnings = FALSE,
    recursive = TRUE
  )
  if (verbose) {
    message(
      "Running GCAE with arguments: '", paste0(args, collapse = " "), " \n",
      "Tip: you should be able to copy-paste this :-)"
    )
  }
  output <- gcaer::run_gcae(
    args = args,
    gcae_options = gcae_options,
    verbose = verbose
  )
  if (verbose) {
    message("GCAE output: \n", paste0(output, collapse = "\n"))
  }
  ae_out_subfolder <- gcaer::get_gcae_output_subfolder(gcae_setup = gcae_setup)
  if (!dir.exists(ae_out_subfolder)) {
    stop(
      "'ae_out_subfolder' not found at path '", ae_out_subfolder, "' \n",
      paste0(gcaer::gcae_setup_to_str(gcae_setup), collapse = "\n"), "\n",
      paste0(gcaer::gcae_options_to_str(gcae_options), collapse = "\n"), "\n",
      "'args': '", paste0(args, collapse = " "), "' \n",
      "Tip: you should be able to copy-paste the args :-)"
    )
  }
  testthat::expect_true(dir.exists(ae_out_subfolder))
  train_filenames <- list.files(
    path = ae_out_subfolder,
    full.names = TRUE,
    recursive = FALSE,
    include.dirs = FALSE,
    pattern = ".*train.*\\.csv$"
  )
  train_filenames
}