R/package.R

In cuml: R Interface for the RAPIDS cuML Suite of Libraries

#' cuml
#'
#' This package provides a R interface for the RAPIDS cuML library.
#'
#' @docType package
#' @author Yitao Li <yitao@rstudio.com>
#' @import Rcpp
#' @useDynLib cuml, .registration = TRUE
#' @name cuml
NULL

.cuml_parsnip_init_done <- FALSE

.onLoad <- function(libname, pkgname) {
  if (!has_libcuml()) {
    if (is.na(Sys.getenv("_R_CHECK_CRAN_INCOMING_", unset = NA))) {
      warning(
        "
        The current installation of {", pkgname, "} will not function as expected
        because it was not linked with a valid version of the RAPIDS cuML shared
        library.

        To fix this issue, please follow https://rapids.ai/start.html#get-rapids
        to install the RAPIDS cuML shared library from Conda and ensure the
        'CUDA_PATH' env variable is set to a valid RAPIDS conda env directory
        (e.g., '/home/user/anaconda3/envs/rapids-21.06' or similar) during the
        installation of {", pkgname, "} or alternatively, follow
        https://github.com/yitao-li/cuml-installation-notes#build-from-source-without-conda-and-without-multi-gpu-support
        or
        https://github.com/yitao-li/cuml-installation-notes#build-from-source-without-conda-and-with-multi-gpu-support
        or similar to build and install RAPIDS cuML library from source, and
        then re-install {", pkgname, "}.\n\n"
      )
    }
  }

  if (identical(.cuml_parsnip_init_done, FALSE)) {
    register_rand_forest_model(pkgname)
    register_svm_model(pkgname)
    register_knn_model(pkgname)
    .cuml_parsnip_init_done <<- TRUE
  }
}