Hendrik/xgboost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[doc] Use cross references in sphinx doc. (#7522)

Browse Source 
* Use cross references instead of URL.
* Fix auto doc for callback.
This commit is contained in:
Jiaming Yuan
2022-01-05 03:21:25 +08:00
committed by GitHub
parent eb1efb54b5
commit 54582f641a
11 changed files with 93 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/parameter.rst
View File

@@ -16,10 +16,13 @@ Before running XGBoost, we must set three types of parameters: general parameter
:backlinks: none
:local:
.. _global_config:
********************
Global Configuration
********************
The following parameters can be set in the global scope, using ``xgb.config_context()`` (Python) or ``xgb.set.config()`` (R).
The following parameters can be set in the global scope, using :py:func:`xgboost.config_context()` (Python) or ``xgb.set.config()`` (R).
* ``verbosity``: Verbosity of printing messages. Valid values of 0 (silent), 1 (warning), 2 (info), and 3 (debug).
* ``use_rmm``: Whether to use RAPIDS Memory Manager (RMM) to allocate GPU memory. This option is only applicable when XGBoost is built (compiled) with the RMM plugin enabled. Valid values are ``true`` and ``false``.