49 lines
1.9 KiB
R
49 lines
1.9 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/xgb.config.R
|
|
\name{xgb.set.config, xgb.get.config}
|
|
\alias{xgb.set.config, xgb.get.config}
|
|
\alias{xgb.set.config}
|
|
\alias{xgb.get.config}
|
|
\title{Set and get global configuration}
|
|
\usage{
|
|
xgb.set.config(...)
|
|
|
|
xgb.get.config()
|
|
}
|
|
\arguments{
|
|
\item{...}{List of parameters to be set, as keyword arguments}
|
|
}
|
|
\value{
|
|
\code{xgb.set.config()} returns \code{TRUE} to signal success. \code{xgb.get.config()} returns
|
|
a list containing all global-scope parameters and their values.
|
|
}
|
|
\description{
|
|
Global configuration consists of a collection of parameters that can be applied in the global
|
|
scope. See \url{https://xgboost.readthedocs.io/en/stable/parameter.html} for the full list of
|
|
parameters supported in the global configuration. Use \code{xgb.set.config()} to update the
|
|
values of one or more global-scope parameters. Use \code{xgb.get.config()} to fetch the current
|
|
values of all global-scope parameters (listed in
|
|
\url{https://xgboost.readthedocs.io/en/stable/parameter.html}).
|
|
}
|
|
\details{
|
|
Note that serialization-related functions might use a globally-configured number of threads,
|
|
which is managed by the system's OpenMP (OMP) configuration instead. Typically, XGBoost methods
|
|
accept an \code{nthreads} parameter, but some methods like \code{\link[=readRDS]{readRDS()}} might get executed before such
|
|
parameter can be supplied.
|
|
|
|
The number of OMP threads can in turn be configured for example through an environment variable
|
|
\code{OMP_NUM_THREADS} (needs to be set before R is started), or through \code{RhpcBLASctl::omp_set_num_threads}.
|
|
}
|
|
\examples{
|
|
# Set verbosity level to silent (0)
|
|
xgb.set.config(verbosity = 0)
|
|
# Now global verbosity level is 0
|
|
config <- xgb.get.config()
|
|
print(config$verbosity)
|
|
# Set verbosity level to warning (1)
|
|
xgb.set.config(verbosity = 1)
|
|
# Now global verbosity level is 1
|
|
config <- xgb.get.config()
|
|
print(config$verbosity)
|
|
}
|