gcae_train: Train model, and save its state at certain epochs to disk.

In richelbilderbeek/gcaer: Interface to GCAE

Train model, and save its state at certain epochs to disk.

Description

Train model, and save its state at certain epochs to disk, use the GCAE command-line interface.

Usage

gcae_train(
  gcae_setup,
  epochs = 1,
  save_interval = 1,
  gcae_options = create_gcae_options(),
  verbose = FALSE
)

Arguments

gcae_setup	GCAE model setup, as created by create_gcae_setup, read from file by read_gcae_setup_file, checked by check_gcae_setup, and saved to file by save_gcae_setup.
epochs	number of epochs, as checked by check_epochs
save_interval	epoch intervals at which to save state of model, and at which to calculate the valid loss
gcae_options	options to run GCAE, as created by create_gcae_options
verbose	the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

Details

This will train the model from epoch zero. To resume training, use gcae_train_more

Value

full paths to the created files

Author(s)

Richèl J.C. Bilderbeek

See Also

Use gcae_train_more to continue training. Use create_gcae_train_args to get the command-line arguments.

Examples

if (plinkr::is_on_ci() && has_cloned_gcae_repo()) {
  gcae_options <- create_gcae_options()
  gcae_setup <- create_test_gcae_setup()
  train_filenames <- gcae_train(
    gcae_setup = gcae_setup,
    epochs = 1,
    save_interval = 1
  )
}

richelbilderbeek/gcaer documentation built on March 25, 2024, 3:08 p.m.