From a899e8f4cd04b56c52958c09d048971dbd521b4c Mon Sep 17 00:00:00 2001 From: Philip Hyunsu Cho Date: Wed, 22 Aug 2018 22:47:10 -0700 Subject: [PATCH] Document CUDA requirement, lack of external memory on GPU (#3624) * Document fact that GPU doesn't support external memory * Document CUDA requirement --- doc/gpu/index.rst | 6 ++++++ doc/tutorials/external_memory.rst | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/doc/gpu/index.rst b/doc/gpu/index.rst index dc0f877e6..06cd2c08c 100644 --- a/doc/gpu/index.rst +++ b/doc/gpu/index.rst @@ -5,6 +5,12 @@ XGBoost GPU Support This page contains information about GPU algorithms supported in XGBoost. To install GPU support, checkout the :doc:`/build`. +.. note:: CUDA 8.0, Compute Capability 3.5 required + + The GPU algorithms in XGBoost require a graphics card with compute capability 3.5 or higher, with + CUDA toolkits 8.0 or later. + (See `this list `_ to look up compute capability of your GPU card.) + ********************************************* CUDA Accelerated Tree Construction Algorithms ********************************************* diff --git a/doc/tutorials/external_memory.rst b/doc/tutorials/external_memory.rst index ba6bbe6b8..c5f064fdc 100644 --- a/doc/tutorials/external_memory.rst +++ b/doc/tutorials/external_memory.rst @@ -13,6 +13,10 @@ The external memory version takes in the following filename format: The ``filename`` is the normal path to libsvm file you want to load in, and ``cacheprefix`` is a path to a cache file that XGBoost will use for external memory cache. +.. note:: External memory is not available with GPU algorithms + + External memory is not available when ``tree_method`` is set to ``gpu_exact`` or ``gpu_hist``. + The following code was extracted from `demo/guide-python/external_memory.py `_: .. code-block:: python