R/run_bayesbench.R

In MansMeg/bayesbenchr: Package to enable quick analysis of posterior approximation algorithms.

#' Run Bayesbench 
#' 
#' @description 
#' Run Bayesbench for a given set of configurations
#' 
#' @param cfg a \code{bayesbench_cfg} object or a list of \code{bayesbench_cfg} object.
#' 
#' @examples 
#' path <- system.file("extdata", "examples", "test_8schools_advi.yml", package = "bayesbenchr")
#' cfg <- read_bayesbench_cfg_from_file(path)
#' # results <- bayesbench_run(cfg)
#' 
#' @export
bayesbench_run <- function(cfg){
  if(checkmate::test_class(cfg, "bayesbench_cfg")){
    cfg <- list(cfg)
  }
  for(i in seq_along(cfg)){
    checkmate::assert_class(cfg[[i]], "bayesbench_cfg")
  }
  # cfg is a list of bayesbench_cfg objects from now on.

  # Create job configs
  cfgs <- expand_bayesbench_cfg_to_job_cfgs(cfg)
  
  # Run all jobs
  pb <- progress::progress_bar$new(format = "Running Bayesbench [:bar] :percent in :elapsed", total = length(cfgs), clear = FALSE)
  results <- list()
  for(i in seq_along(cfgs)){
    pb$tick()
    if(output_file_exist(cfgs[[i]])) {
      message("Skipped ", config_name(cfgs[[i]]), " since output file exist. Use 'overwrite = TRUE' in config to force run.")
      next()
    }
    start_time <- Sys.time()
    inference_engine <- inference_engine_function(cfgs[[i]])
    results[[i]] <- inference_engine(cfg = cfgs[[i]])
    end_time <- Sys.time()
    #add_start_time(results[[i]]) <- start_time
    #add_end_time(results[[i]]) <- end_time
    
    # Write results (continously)
    write_bayesbench_outputs(bayesbench_outputs = results[i])
  }
  

  # Warnings
  warning("diagnostics not implemented yet", call. = FALSE)
  
  return(invisible(results))
}

#' @rdname bayesbench_run
#' @param bash_folder Folder to write bash scripts to
#' @param cores how many files to run (to start as differet processes)
#' @export
bayesbench_bash_run <- function(cfg, bash_folder = "temp_bayesbench", processes = 1){
  if(checkmate::test_class(cfg, "bayesbench_cfg")){
    cfg <- list(cfg)
  }
  for(i in seq_along(cfg)){
    checkmate::assert_class(cfg[[i]], "bayesbench_cfg")
  }
  # cfg is a list of bayesbench_cfg objects from now on.
  
  # Create job configs
  cfgs <- expand_bayesbench_cfg_to_job_cfgs(cfg)
  
  # Create temp dir for runs  
  dir.create(bash_folder, showWarnings = FALSE)
  dir.create(file.path(bash_folder, "cfgs"), showWarnings = FALSE)
  
  # Copy run_bayesbench
  file.copy(system.file("extdata", "rscripts", "bayesbench.R", package = "bayesbenchr"),
            file.path(bash_folder, "bayesbench.R"), overwrite = TRUE)

  # Create configs
  cfg_path <- character(length(cfgs))
  for(i in seq_along(cfgs)){
    cfg_path[i] <- file.path(bash_folder, "cfgs", paste0(config_name(cfgs[[i]]),".yml"))
    write_bayesbench_cfg_to_file(cfg = cfgs[[i]], cfg_path[i])
  }
  
  # Create bash
  bash_file <- c("#!/bin/bash", "", paste0("Rscript ", file.path(bash_folder, "bayesbench.R"), " --cfg_path=\"", cfg_path, "\""))
  writeLines(bash_file, con = file.path(bash_folder, "run_bayesbench.sh"))
  # Convert to bayesbench output
  if(processes>1){
    cfg_path_idx <- rep(1:processes, ceiling(length(cfg_path)/processes))[1:length(cfg_path)]
    for(i in 1:processes){
      bash_file <- c("#!/bin/bash", "", paste0("Rscript ", file.path(bash_folder, "bayesbench.R"), " --cfg_path=\"", cfg_path[cfg_path_idx == i], "\""))
      writeLines(bash_file, con = file.path(bash_folder, paste0("run_bayesbench", i, ".sh")))
    }
  }

  cat("Run bash", file.path(bash_folder, "run_bayesbench.sh"), "in terminal.\n")
  return(invisible(TRUE))
}