create_gcae_experiment_params: Create the parameters for a GCAE experiment

In richelbilderbeek/gcaer: Interface to GCAE

Create the parameters for a GCAE experiment

Description

Create the parameters for a GCAE experiment

Usage

create_gcae_experiment_params(
  gcae_setup,
  analyse_epochs,
  metrics,
  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.
analyse_epochs	the epochs to analyse, e.g. c(1, 2, 3), as checked by check_analyse_epochs
metrics	the metrics, as checked by check_metrics. Use "" to indicate not to use a clusting metric
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.

Value

the parameters for a GCAE experiment

Author(s)

Richèl J.C. Bilderbeek

Examples

create_gcae_experiment_params(
  gcae_setup = create_test_gcae_setup(),
  analyse_epochs = seq(1, 2, 3),
  metrics = "f1_score_3,f1_score_3"
)

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