Skip to content

Commit

Permalink
Document CUDA requirement, lack of external memory on GPU (dmlc#3624)
Browse files Browse the repository at this point in the history
* Document fact that GPU doesn't support external memory

* Document CUDA requirement
  • Loading branch information
hcho3 authored and Nan Zhu committed Aug 29, 2018
1 parent 3960ac4 commit a78a5d1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/gpu/index.rst
Expand Up @@ -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 <https://en.wikipedia.org/wiki/CUDA#GPUs_supported>`_ to look up compute capability of your GPU card.)

*********************************************
CUDA Accelerated Tree Construction Algorithms
*********************************************
Expand Down
4 changes: 4 additions & 0 deletions doc/tutorials/external_memory.rst
Expand Up @@ -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 <https://github.com/dmlc/xgboost/blob/master/demo/guide-python/external_memory.py>`_:

.. code-block:: python
Expand Down

0 comments on commit a78a5d1

Please sign in to comment.