global_config.h

Go to the documentation of this file.

 
#ifndef XGBOOST_GLOBAL_CONFIG_H_
#define XGBOOST_GLOBAL_CONFIG_H_
 
#include <dmlc/thread_local.h>  // for ThreadLocalStore
#include <xgboost/parameter.h>  // for XGBoostParameter
 
#include <cstdint>  // for int32_t
 
namespace xgboost {
struct GlobalConfiguration : public XGBoostParameter<GlobalConfiguration> {
  std::int32_t verbosity{1};
  bool use_rmm{false};
  bool use_cuda_async_pool{false};
  // This is not a dmlc parameter to avoid conflict with the context class.
  std::int32_t nthread{0};
  DMLC_DECLARE_PARAMETER(GlobalConfiguration) {
    DMLC_DECLARE_FIELD(verbosity)
        .set_range(0, 3)
        .set_default(1)  // shows only warning
        .describe("Flag to print out detailed breakdown of runtime.");
    DMLC_DECLARE_FIELD(use_rmm).set_default(false).describe(
        "Whether to use RAPIDS Memory Manager to allocate GPU memory in XGBoost");
    DMLC_DECLARE_FIELD(use_cuda_async_pool)
        .set_default(false)
        .describe("Whether to use the async memory pool in CUDA.");
  }
};
 
using GlobalConfigThreadLocalStore = dmlc::ThreadLocalStore<GlobalConfiguration>;
 
struct InitNewThread {
  GlobalConfiguration config;
  std::int32_t device{-1};
 
  void operator()() const;
  InitNewThread();
};
}  // namespace xgboost
 
#endif  // XGBOOST_GLOBAL_CONFIG_H_