xgbdl: xgboost Installer from Source

#' Install xgboost from source
#' 
#' Downloads and install xgboost from repository. Allows to customize the commit/branch used. Requires \code{git} and compiler \code{make} (or \code{mingw32-make} for MinGW) in \code{PATH} environment variable. Windows uses \code{\\\\} (backward slashes) while Linux uses \code{/} (forward slashes).
#' 
#' @param commit The commit / branch to use. Put \code{""} for master branch. Defaults to \code{"master"}.
#' @param compiler Applicable only to Windows. The compiler to use (either \code{"gcc"} for MinGW, \code{"Visual Studio 15 2017"} for Visual Studio). Defaults to \code{"gcc"}. Use \code{"Visual Studio 14 2015 Win64"} for the officially supported Visual Studio 2015.
#' @param repo The link to the repository. Defaults to \code{"https://github.com/dmlc/xgboost"}.
#' @param cores The number of cores to use for compilation, ignored for Visual Studio. Defaults to \code{1}.
#' @param use_gpu Whether to install with GPU enabled or not. Defaults to \code{FALSE}. Disabled for Windows + MinGW.
#' @param use_avx Whether to install with AVX enabled or not. Defaults to \code{FALSE}. Disabled for Windows + MinGW.
#' @param CUDA Path to CUDA, gcc, and g++ if cmake does not recognize CUDA path. Defaults to \code{list(NULL, NULL, NULL)}. Disabled for Windows. Please specify a list. Example: \code{CUDA = list("/usr/lib/cuda", "/usr/bin/gcc-6", "/usr/bin/g++-6")}.
#' @param NCCL Activate NCCL by specifying the path to NCCL. Defaults to \code{NULL}. Disabled for Windows. Example: \code{NCCL = "/usr/lib/x86_64-linux-gnu"}
#' 
#' @return A logical describing whether the xgboost package was installed or not (\code{TRUE} if installed, \code{FALSE} if installation failed AND you did not have the package before).
#' 
#' @examples
#' \dontrun{
#' # Install using Visual Studio 2017
#' # (Download: http://landinghub.visualstudio.com/visual-cpp-build-tools)
#' xgb.dl(compiler = "Visual Studio 15 2017 Win64")
#' 
#' # Install using Rtools MinGW or use Linux compilation
#' xgb.dl(compiler = "gcc")
#' 
#' # Install master using Visual Studio 2017 with GPU support
#' xgb.dl(commit = "master",
#'        compiler = "Visual Studio 15 2017 Win64",
#'        repo = "https://github.com/dmlc/xgboost",
#'        use_gpu = TRUE)
#' 
#' # Install master using Visual Studio 2017 with GPU support and AVX speedups
#' xgb.dl(commit = "master",
#'        compiler = "Visual Studio 15 2017 Win64",
#'        repo = "https://github.com/dmlc/xgboost",
#'        use_gpu = TRUE,
#'        use_avx = TRUE)
#' 
#' # Test package
#' library(xgboost)
#' data(agaricus.train, package = "xgboost")
#' data(agaricus.test, package = "xgboost")
#' 
#' dtrain <- xgb.DMatrix(agaricus.train$data, label = agaricus.train$label)
#' dtest <- xgb.DMatrix(agaricus.test$data, label = agaricus.test$label)
#' watchlist <- list(train = dtrain, eval = dtest)
#' 
#' param <- list(max_depth = 2, eta = 1, silent = 1, nthread = 2,
#'               objective = "binary:logistic", eval_metric = "auc")
#' bst <- xgb.train(param, dtrain, nrounds = 2, watchlist)
#' 
#' 
#' 
#' # Install with GPU support on Linux, CUDA 10 + gcc-6 + g++-6
#' xgb.dl(compiler = "gcc",
#'        commit = "a2dc929",
#'        use_avx = FALSE,
#'        use_gpu = TRUE,
#'        CUDA = list("/usr/lib/cuda", "/usr/bin/gcc-6", "/usr/bin/g++-6"))
#' 
#' # Test GPU package
#' library(xgboost)
#' data(agaricus.train, package = "xgboost")
#' data(agaricus.test, package = "xgboost")
#' 
#' dtrain <- xgb.DMatrix(agaricus.train$data, label = agaricus.train$label)
#' dtest <- xgb.DMatrix(agaricus.test$data, label = agaricus.test$label)
#' watchlist <- list(train = dtrain, eval = dtest)
#' 
#' param <- list(max_depth = 2, eta = 1, silent = 1, nthread = 2,
#'               objective = "binary:logistic", eval_metric = "auc",
#'               max_bin = 64, tree_method = "gpu_hist")
#' bst <- xgb.train(param, dtrain, nrounds = 2, watchlist)
#' 
#' 
#' 
#' # Install with multi-GPU support on Linux, CUDA 10 + gcc-6 + g++-6
#' xgb.dl(compiler = "gcc",
#'        commit = "a2dc929",
#'        use_avx = FALSE,
#'        use_gpu = TRUE,
#'        CUDA = list("/usr/lib/cuda", "/usr/bin/gcc-6", "/usr/bin/g++-6"),
#'        NCCL = "/usr/lib/x86_64-linux-gnu")
#' 
#' # Test Multi-GPU package
#' library(xgboost)
#' data(agaricus.train, package = "xgboost")
#' data(agaricus.test, package = "xgboost")
#' 
#' dtrain <- xgb.DMatrix(agaricus.train$data, label = agaricus.train$label)
#' dtest <- xgb.DMatrix(agaricus.test$data, label = agaricus.test$label)
#' watchlist <- list(train = dtrain, eval = dtest)
#' 
#' param <- list(max_depth = 2, eta = 1, silent = 1, nthread = 2,
#'               objective = "binary:logistic", eval_metric = "auc",
#'               max_bin = 64, tree_method = "gpu_hist", n_gpus = 4)
#' bst <- xgb.train(param, dtrain, nrounds = 2, watchlist)
#' 
#' }
#' 
#' @export

xgb.dl <- function(commit = "master",
                   compiler = "gcc",
                   repo = "https://github.com/dmlc/xgboost",
                   cores = 1,
                   use_gpu = FALSE,
                   use_avx = FALSE,
                   CUDA = NULL,
                   NCCL = NULL) {
  
  # Generates temporary dir
  xgb_git_dir <- tempdir()
  
  # Check if it is Windows, because it create most issues
  if (.Platform$OS.type == "windows") {
    
    # Create temp file
    xgb_git_file <- file.path(xgb_git_dir, "temp.bat", fsep = "\\")
    
    # Delete (old) temp xgboost folder
    unlink(paste0(file.path(xgb_git_dir, "xgboost", fsep = "\\")), recursive = TRUE, force = TRUE)
    
    # Use git to fetch data from repository
    cat(paste0("c:", "\n"), file = xgb_git_file)
    cat(paste0("cd ", xgb_git_dir, "\n"), file = xgb_git_file, append = TRUE)
    cat(paste0("git clone --recursive ", repo, "\n"), file = xgb_git_file, append = TRUE)
    cat(paste0("cd xgboost", "\n"), file = xgb_git_file, append = TRUE)
    
    # Checkout specific commit if needed
    if (commit != "") {
      cat(paste0("git checkout ", commit, "\n"), file = xgb_git_file, append = TRUE)
    }
    
    # Check if compilation must be done using MinGW/gcc (default) or Visual Studio
    if (compiler == "gcc") {
      
      cat(paste0("cd R-package", "\n"), file = xgb_git_file, append = TRUE)
      cat("R CMD INSTALL .\n", file = xgb_git_file, append = TRUE)
      
    } else {
      
      cat(paste0("mkdir build && cd build", "\n"), file = xgb_git_file, append = TRUE)
      cat(paste0("cmake .. -G\"", compiler, "\"", ifelse(use_gpu == TRUE, " -DUSE_CUDA=ON", ""), ifelse(use_avx == TRUE, " -DUSE_AVX=ON", ""), " -DR_LIB=ON", "\n"), file = xgb_git_file, append = TRUE)
      cat("cmake --build . --target install --config Release\n", file = xgb_git_file, append = TRUE)
      
    }
    
    # Do actions
    system(xgb_git_file)
    
    # Get rid of the created temporary folder
    unlink(paste0(file.path(xgb_git_dir, "xgboost", fsep = "\\")), recursive = TRUE, force = TRUE)
    
  } else {
    
    # Create temp file
    xgb_git_file <- file.path(xgb_git_dir, "temp.sh")
    
    # Delete (old) temp xgboost folder
    unlink(paste0(file.path(xgb_git_dir, "xgboost")), recursive = TRUE, force = TRUE)
    
    # Use git to fetch data from repository
    cat(paste0("cd ", xgb_git_dir, "\n"), file = xgb_git_file)
    cat(paste0("git clone --recursive ", repo, "\n"), file = xgb_git_file, append = TRUE)
    cat(paste0("cd xgboost", "\n"), file = xgb_git_file, append = TRUE)
    
    # Checkout specific commit if needed
    if (commit != "") {
      cat(paste0("git checkout ", commit, "\n"), file = xgb_git_file, append = TRUE)
    }
    
    # Compile
    
    cat(paste0("mkdir build && cd build", "\n"), file = xgb_git_file, append = TRUE)
    if (is.null(CUDA[[1]]) == TRUE) {
      if (is.null(NCCL) == TRUE) {
        cat(paste0("cmake .. ", ifelse(use_gpu == TRUE, " -DUSE_CUDA=ON", ""), ifelse(use_avx == TRUE, " -DUSE_AVX=ON", ""), " -DR_LIB=ON", "\n"), file = xgb_git_file, append = TRUE)
      } else {
        cat(paste0("cmake .. ", ifelse(use_gpu == TRUE, paste0(" -DUSE_CUDA=ON -DUSE_NCCL=ON -DNCCL_ROOT=", NCCL), ""), ifelse(use_avx == TRUE, " -DUSE_AVX=ON", ""), " -DR_LIB=ON", "\n"), file = xgb_git_file, append = TRUE)
      }
    } else {
      if (is.null(NCCL) == TRUE) {
        cat(paste0("cmake .. ", ifelse(use_gpu == TRUE, paste0(" -DUSE_CUDA=ON -DCUDA_TOOLKIT_ROOT_DIR=", CUDA[[1]], " -DCMAKE_C_COMPILER=", CUDA[[2]], " -DCMAKE_CXX_COMPILER=", CUDA[[3]]), ""), ifelse(use_avx == TRUE, " -DUSE_AVX=ON", ""), " -DR_LIB=ON", "\n"), file = xgb_git_file, append = TRUE)
      } else {
        cat(paste0("cmake .. ", ifelse(use_gpu == TRUE, paste0(" -DUSE_CUDA=ON -DCUDA_TOOLKIT_ROOT_DIR=", CUDA[[1]], " -DCMAKE_C_COMPILER=", CUDA[[2]], " -DCMAKE_CXX_COMPILER=", CUDA[[3]], " -DUSE_NCCL=ON -DNCCL_ROOT=", NCCL), ""), ifelse(use_avx == TRUE, " -DUSE_AVX=ON", ""), " -DR_LIB=ON", "\n"), file = xgb_git_file, append = TRUE)
      }
    }
    cat(paste0("make install -j", cores, "\n"), file = xgb_git_file, append = TRUE)
    
    # Set permissions on script
    Sys.chmod(xgb_git_file, mode = "0777", use_umask = TRUE)
    
    # Do actions
    system(xgb_git_file)
    
    # Get rid of the created temporary folder
    unlink(paste0(file.path(xgb_git_dir, "xgboost")), recursive = TRUE, force = TRUE)
    
  }
  
  return(nzchar(system.file(package = "xgboost")))
  
}