Unverified Commit 43f021bf authored by James Lamb's avatar James Lamb Committed by GitHub
Browse files

[docs] remove language about CUDA version being experimental (fixes #6340) (#6371)

parent 6265c980
...@@ -624,9 +624,8 @@ Build CUDA Version ...@@ -624,9 +624,8 @@ Build CUDA Version
The `original GPU build <#build-gpu-version>`__ of LightGBM (``device_type=gpu``) is based on OpenCL. The `original GPU build <#build-gpu-version>`__ of LightGBM (``device_type=gpu``) is based on OpenCL.
The CUDA-based build (``device_type=cuda``) is a separate implementation and requires an NVIDIA graphics card with compute capability 6.0 and higher. It should be considered experimental, and we suggest using it only when it is impossible to use OpenCL version (for example, on IBM POWER microprocessors). The CUDA-based build (``device_type=cuda``) is a separate implementation.
Use this version in Linux environments with an NVIDIA GPU with compute capability 6.0 or higher.
**Note**: only Linux is supported, other operating systems are not supported yet.
Linux Linux
^^^^^ ^^^^^
...@@ -654,6 +653,17 @@ To build LightGBM CUDA version, run the following commands: ...@@ -654,6 +653,17 @@ To build LightGBM CUDA version, run the following commands:
**Note**: In some rare cases you may need to install OpenMP runtime library separately (use your package manager and search for ``lib[g|i]omp`` for doing this). **Note**: In some rare cases you may need to install OpenMP runtime library separately (use your package manager and search for ``lib[g|i]omp`` for doing this).
macOS
^^^^^
The CUDA version is not supported on macOS.
Windows
^^^^^^^
The CUDA version is not supported on Windows.
Use the GPU version (``device_type=gpu``) for GPU acceleration on Windows.
Build HDFS Version Build HDFS Version
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
......
...@@ -28,7 +28,7 @@ $(function() { ...@@ -28,7 +28,7 @@ $(function() {
'#build-threadless-version-not-recommended', '#build-threadless-version-not-recommended',
'#build-mpi-version', '#build-mpi-version',
'#build-gpu-version', '#build-gpu-version',
'#build-cuda-version-experimental', '#build-cuda-version',
'#build-hdfs-version', '#build-hdfs-version',
'#build-java-wrapper', '#build-java-wrapper',
'#build-c-unit-tests' '#build-c-unit-tests'
......
...@@ -153,7 +153,7 @@ Build CUDA Version ...@@ -153,7 +153,7 @@ Build CUDA Version
All requirements from `Build from Sources section <#build-from-sources>`__ apply for this installation option as well, and `CMake`_ (version 3.16 or higher) is strongly required. All requirements from `Build from Sources section <#build-from-sources>`__ apply for this installation option as well, and `CMake`_ (version 3.16 or higher) is strongly required.
**CUDA** library (version 10.0 or higher) is needed: details for installation can be found in `Installation Guide <https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-cuda-version-experimental>`__. **CUDA** library (version 10.0 or higher) is needed: details for installation can be found in `Installation Guide <https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-cuda-version>`__.
To use the CUDA version within Python, pass ``{"device": "cuda"}`` respectively in parameters. To use the CUDA version within Python, pass ``{"device": "cuda"}`` respectively in parameters.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment